主なパラメータ例
本APIで送信可能なパラメータ群は以下の通りです。
「パラメータ」は、実際にAPIが受付可能なパラメータ名となる文字列を指し、「有効値/制限等」は、当該パラメータに対し設定が可能な値と制限が記載されております。「補足」に任意と記載のあるパラメータは、リクエストに際し付加せずに通信が可能です。必須と記載のあるパラメータは、リクエストに際し必ず付加する必要がございます。
| パラメータ | 有効値／制限等 | 説明 | 補足 |
|---|---|---|---|
mobilecareer | 英数、1桁 1,2,3,4,a,b,cのいずれかの値 | キャリア指定/IVR認証挙動指定/国外配信指定。 1 = docomo 2 = Softbank 3 = au 4 = Ymobile a = IVR認証時に固定回線番号のみに対応 b = IVR認証時に全ての番号に対応 c = 海外通信キャリアへ配信 | 任意 キャリア判別（1～4）は自動で行うため指定する必要はない |
mobilenumber | 数値、11桁 090/080/070/060/020から始まる値 | 宛先電話番号 IVR認証利用時で且つmobilecareerにa又はbを指定した場合は10桁や03番号も可。 海外SMS送信は国番号を先頭に必須で11桁以上 | 必須 |
smstitle | 英数、2～11桁 数値のみは不可 a～z、A～Z、0～9 | SMSの送信元表示。 国際網からの配信時のみ適用されその他の配信網の場合には無視される | 任意 |
smstextid | 数値 予め管理画面上で定義済みの値のみ使用可 | SMSの本文 管理画面上でテンプレートとして登録している場合に当該テンプレートのIDを数値で呼び出す。 | 必須 smstextを使用する場合には使用不可 |
smstext | 140byte 環境依存文字を除くいずれかの値 長文の場合は1340 byte | SMSの本文。 通信キャリア側の仕様によりau以外では本文中に2byte文字が1文字でも存在すると半角全角問わず70文字までとなる Shift_JIS換算で140byteを超えた値は切り捨てとなる ※長文オプション利用時は、こちらのパラメータで670文字(1340byte)まで指定できます。長文時にこのパラメータだけを本文として設定することで、すべてのキャリアに送信可能です。 | 必須 smstextidを使用する場合には使用不可 文字コードはUTF-8。 |
smstext2 | 140byte(Shift-JIS) 環境依存文字を除くいずれかの値 長文の場合は1340 byte(UTF-16) | 長文SMSのau用本文。 基本的に設定は必要ありません。 長文オプション利用時にこのパラメータを指定した場合、auへの長文送信時にはこのパラメータの値が本文として適用される。 ※キャリア毎に個別で本文を変えたい場合に設定してください。 | 任意 smstextidを使用する場合には使用不可 ※長文の場合には任意オプション(長文)。利用希望は営業まで |
status | 数値、1桁 0,1のいずれかの値 | SMS送達結果通知用API利用フラグ。 0 = 受け取らない 1 = 受け取る | 任意 |
smsid | 英数字大小、1～50桁 | SMS送達結果通知利用時におけるリクエスト判別用の値。 | 任意 |
method | 数値、1桁 1,2,4,5,6,7のいずれかの値 | IVR認証の設定。 1 = SMS送信のみ 2 = SMS送信＆IVR認証受付 4 = IVR認証受付のみ 5=発信コール（mobilecareer=cは利用不可） その際にはReturnAPI経由でauthcodeへ生成された番号を渡します。 | 任意 |
ipphone | 数値、11桁 050から始まる値 | IVR認証の受付、または発信用電話番号。 アカウント発行時に提供された値 | 任意 IVR認証利用時は必須 method=5利用時は必須。 |
holdingtime | 数値、0-999まで | IVR認証の受付可能時間（単位：分） | 任意 method=5利用時は必須。 |
repeatcall | 数値、0～99の回数を指定 | 発信コール利用時に使用。電話に出るまでのコールの回数を設定。 | method=5利用時は必須。 |