主なパラメータ例（CSV）
本APIで送信可能な主なパラメータです。
「パラメータ」はAPIが受付可能なパラメータ名となる文字列を指し、「有効値/制限等」は当該パラメータに対し設定が可能な値と制限が記載されています。「補足」に任意と記載のあるパラメータはリクエストに際し付加せずに通信が可能です。必須と記載のあるパラメータは必ず付加してリクエストください。
また、 「ReturnAPIで元パラメータ維持」オプション有効時は、本APIで送信した任意のパラメータと値がそのまま送達結果取得API（SMS 送達結果通知形式）で送信されます。
| パラメータ | 有効値／制限等 | 説明 | 補足 |
|---|---|---|---|
username | 英数一部記号 2～20 桁 | 認証時のユーザーネーム | 任意（Basic認証利用の場合は不要） |
password | 英数記号 6～20 桁 | 認証時のパスワード | 任意（Basic認証利用の場合は不要） |
encode | utf8, shiftjisのいずれか | CSVファイルの文字コード ※デフォルトはutf8 | 任意 |
smstexttype | csv, idのいずれか | SMS本文の指定方法 csvの場合はcsvファイル10列目に本文を記載し、idの場合は、管理画面で事前に登録したテンプレートIDをcsvファイル8列目に指定します。 | 必須 idの場合は、事前に管理画面にてテンプレートの登録が必要 |
start | 数値のみ12桁 | SMS送信開始日時 YYYYMMDDhhmmのフォーマットで送信予定日時を指定します。 | 任意 |
smstitle | 英数一部記号 2～11 桁 数値のみは不可 | SMSの送信元表示 国際網からの配信時のみ適用されその他の配信網の場合には無視されます。「-」, 「_」, 「.」文字も利用可能です。 | 任意 ※海外配信時のみ有効 |
smstextid | 数値6 桁以内 0～999999 まで 予め管理画面上で登録済み の値のみ使用可 | 利用するテンプレートID 管理画面で登録済みのテンプレートID（数値）を指定して、SMS本文とします。 | 任意 CSVファイル内で指定する場合は不要。 smstextを使用する場合は使用不可 |
smstext | 140byte 環境依存文字を除くいずれかの値 長文の場合は1340byte | SMS本文 通信キャリア側の仕様により、au以外では本文中に2byte文字が1文字でも存在すると半角全角問わず70文字まで、 140byteを超えた値は切り捨てられます。 ※長文オプション利用時は、このパラメータで670文字まで指定可能です。 | 任意 CSVファイルで指定する場合は不要。smstextidを使用する場合は使用不可。 |
smstext2 | 140byte 環境依存文字を除くいずれかの値 | au用のSMS本文 このパラメータを指定した場合、auへの送信時にはこのパラメータの値が本文として適用されます。 | 任意 CSVファイルで指定する場合は不要。 smstextidを使用する場合には使用不可。 |
originalurl | 文字列 最大2083文字 ファイルを送信する場合はファイルサイズ10MBまで | 短縮URL機能利用時のリダイレクト先URL。 status=1を指定することで、該当URLの通知が可能です。短縮URLは、SMS本文の希望挿入位置に{URL}を記載することで挿入されます。 ファイル添付オプション（有料）に申し込み済みの場合は、WebページのURLだけではなく、ファイル設置場所URLを指定してファイルを送信することも可能です。SMS送信リクエスト時にファイルがアップロードされ、リダイレクト先のURLが自動生成されます。 | 任意 短縮URL機能は標準機能としてご利用可能です。 ファイル添付オプション（有料）のお申し込み後、ファイル送信が可能となります。ご希望の場合は弊社営業まで |
sendingattempts | 数値1～10まで | 再送信回数 デフォルトは1。2を設定した場合、送信後に1回送信されます。 | 任意 有料オプション(再送信機能) |