主なパラメータ例（個別）
本APIで送信可能な主なパラメータです。
「パラメータ」はAPIが受付可能なパラメータ名となる文字列を指し、「有効値/制限等」は当該パラメータに対し設定が可能な値と制限が記載されています。「補足」に任意と記載のあるパラメータはリクエストに際し付加せずに通信が可能です。必須と記載のあるパラメータは必ず付加してリクエストください。
また、 「ReturnAPIで元パラメータ維持」オプション有効時は、本APIで送信した任意のパラメータと値がそのまま送達結果取得API（SMS 送達結果通知形式）で送信されます。
| パラメータ | 有効値／制限等 | 説明 | 補足 |
|---|---|---|---|
username | 英数一部記号 2～20 桁 | 認証時のユーザーネーム | 任意（Basic認証利用の場合は不要） |
password | 英数記号 6～20 桁 | 認証時のパスワード | 任意（Basic認証利用の場合は不要） |
mobilenumber | 数字のみ 11桁番号の場合： 020X, 060X, 070X, 080X,090Xで始まる電話番号(Xの値は1～9) 14桁番号の場合： 0200,0600,0700,0800,0900で始まる電話番号 8180,8190から始まる値の場合：12桁以内 0と上記81以外から始まる値の場合：6～20桁 | SMS送信先電話番号 海外送信時には先頭に国番号を付加する必要があります。(例：81、1等) なお、海外送信につきましては、弊社の方針により新規の利用申請は受付不可であるためご了承いただきますようお願いします。 | 必須 ※海外送信はユーザー権限アカウントにてオプション設定が必要 |
smstextid | 数値6 桁以内 0～999999 まで 予め管理画面上で登録済み の値のみ使用可 | 利用するテンプレートID 管理画面で登録済みのテンプレートID （数値）を指定して、SMS本文とします。 | 任意 テンプレート利用の送信時は必須smstextを使用する場合は使用不可 |
smstitle | 英数一部記号 2～11 桁 数値のみは不可 | SMSの送信元表示 海外キャリア網による配信時のみ適用され、未指定の場合の送信元表示は「SMS」となります。なお、国内キャリア網による配信時は指定した場合も無視されます。 一部記号として、 「-」 , 「_」 , 「.」も利用可能です。 | 任意 ※海外配信時のみ有効 |
smstext | 140byte 環境依存文字を除くいずれかの値 長文の場合は1340byte | SMS本文 通信キャリア側の仕様により、au以外では本文中に2byte文字が1文字でも存在すると半角全角問わず70文字まで、 Shift_JIS換算で140byteを超えた値は切り捨てられます。 なお、以下の内容を値として指定した場合、 585エラーが返却されます。 ・本文が空の場合 ・改行のみ ・スペースのみ（半角・全角スペースのみ） ・ユーザー権限アカウントに対して「文字数オーバー制限オプション」が有効の状態で、 140byte（長文オプション有効時は1340byte）を超過した文字数を送信しようとした場合 ※長文オプション利用時にはこのパラメータで670文字まで指定できます。長文時にこのパラメータだけ本文として設定することで、4キャリアに送信出来ます。文字数カウントについては、こちらを参照。 | 任意 テンプレートを利用しない個別の本文送信時は必須。 smstextidを使用する場合には使用不可。 文字コードはUTF-8。 byte数はShift_JISで換算し140byte以内（UTF-16からShift_JISへ変換し処理するため) |
status | 0,1のいずれかの値 | SMS送達結果通知用API利用フラグ 0 = 受け取らない 1 = 受け取る | 任意 |
smsid | 英数字（大小別） 1～50桁 | SMS送達結果通知利用時のリクエスト判別用の値 再送機能+smsid維持のオプション利用時においては、再送時に同じsmsidが引き継がれます。弊社にてオプション設定いたします。 | 任意 status=1を使用する場合必須 |
originalurl | 文字列 最大2083文字 ファイルを送信する場合はファイルサイズ10MBまで | 短縮URL機能利用時のリダイレクト先URL。 status=1を指定することで、該当URLの通知が可能です。短縮URLは、SMS本文の希望挿入位置に{URL}を記載することで挿入されます。 ファイル添付オプション（有料）に申し込み済みの場合は、WebページのURLだけではなく、ファイル設置場所URLを指定してファイルを送信することも可能です。SMS送信リクエスト時にファイルがアップロードされ、リダイレクト先のURLが自動生成されます。 | 任意 短縮URL機能は標準機能としてご利用可能です。 ファイル添付オプション（有料）のお申し込み後、ファイル送信が可能となります。ご希望の場合は弊社営業まで |
info1〜info8 | 255文字以内 文字種不問 | SMS本文のダイナミックタグ{info1}～{info8}に挿入する値 | 任意 |
senddatetime | 数値のみ12桁 | SMS送信開始日時 YYYYMMDDhhmmのフォーマットで送信予定日時を設定します。 | 任意 |
docomo | 数値＋ハイフン n-a-b-c-d-e n=1~5 a,b,c,d,e=0~9999 | ドコモ向けに送信する際の送信処理（初回送信+リトライ）回数と送信処理の試行時間 nは最初の送信1回を含むリトライ回数。a～eはキャリア側で不達時に処理を蓄積し自動再送するTTL（有効時間。単位：分）。 例：5-5-5-5-5-5 この場合、最初に送信1回を5分間にわたって実施し、失敗した場合は4回までリトライされます。リトライは初回送信と同様に5分間ずつキャリアにより自動で送信処理が試行されます。TTLの時間内に送信先端末の状況が改善された場合（圏外→圏内、電源OFF→ON等）は、SMSは「送信済」となります。なお、本パラメーータの送信処理の考え方は以降の「au」「softbank」「rakuten」パラメータに対しても適用されます。 | 任意 デフォルトは3-6-2-2 |
au | au 数値1桁 1から5までのいずれかの値 | au向けに送信する際の送信処理（初回送信+リトライ）回数 キャリア側で不達時に処理を蓄積し自動再送する制限時間は90秒で固定されます。 設定する値は最初の送信1回を含むリトライ回数。 例：au=3の場合 送信1回、リトライ2回となる ※au宛の長文SMSを送信する場合、au側の仕様により、送信結果の返却については平均21分、最大26分かかる場合があります。 そのため、値を「2」で設定した場合、最大で26×2=52分後に送信結果が返却される場合があります。 | 任意 デフォルトは3 |
softbank | 数値＋ハイフン n-a-b-c-d-e n=1~5 a,b,c,d,e=5~1440 | ソフトバンク向けに送信する際の送信処理（初回送信+リトライ）回数と送信処理の試行時間 nは最初の送信1回を含むリトライ回数。a～eはキャリア側で不達時に処理を蓄積し自動再送するTTL（有効時間。単位：分）。 | 任意 デフォルトは2-5-5 |
gateway | 数値＋ハイフン n-a-b-c-d-e n=1～5 a,b,c,d,e=1~9999 | 海外携帯番号向けに送信する際の送信処理（初回送信+リトライ）回数と送信処理の試行時間 nは最初の送信1回を含むリトライ回数。a～eはキャリア側で不達時に処理を蓄積し自動再送するTTL（有効時間。単位：分）。 | 任意 デフォルトは1-5 |
rakuten | 数値＋ハイフン n-a-b-c-d-e n=1~5 a,b,c,d,e=2~4320 | 楽天モバイル向けに送信する際の送信処理（初回送信+リトライ）回数と送信処理の試行時間 nは最初の送信1回を含むリトライ回数。a～eはキャリア側で不達時に処理を蓄積し自動再送するTTL（有効時間。単位：分）。 | 任意 デフォルトは3-2-2-5 |
memo | 255文字までの文字列 または数値のみ255桁「メモ欄の入力制限（半角数字）」オプション有効時 | memoの値に入力した内容がそのまま返却されます。ただし、管理画面で設定したメモタイプの挙動になります。 SMS用：SMSごとにメモを上書きして利用します。 電話番号用：1番号へ複数送信時別々メモがあった場合、最後のメモを選択して記入します。 またメモをAPIリクエストで指定しなくても、リクエストの際、既に過去の送信実績とメモが存在する場合、該当のメモを送信結果取得API経由で渡します。 また、管理画面にて「NGワード機能」を利用している場合、該当ワードが送信された際に「NGワード制御」という文字列がmemoの値として返却されます。 | 任意 memoは無料オプションですが弊社にて設定が必要となるため、弊社サポートまでご連絡をお願いします。memo2～5は有料オプション(メモ欄の複数化)となるため、弊社営業までご連絡をお願いします。 |