SMS送信

詳細

SMSを送信するためには、POSTメソッドで Submit SMS 形式にする必要があります。

エンドポイントEndpoint URL： https://api.cpaas.symphony.rakuten.net/sms/v1/submit

**メソッド：**POST

HTTP ヘッダー

パラメーター	要否	値
Authentication	必須	Type: Bearer Token: JWT Token
Accept	必須	application/json
Content-Type	必須	application/json; charset=UTF-8

リクエストボディスキーマ： application/json

パラメーター	要否	詳細/値
from	必須	要件と設定に応じて、アルファベットまたは数字になります。送信元IDは事前登録が必要となっております。詳しくは送信元IDを参照してください。
to	必須	送信先電話番号は下記の形式になります。国コード + 電話番号(MSISDN) "+" or "0"先頭に"+" または "0"を付けないでください例: 日本国内電話番号070-9830-2393 の場合は、 "817098302393"となります
message_type	必須	以下のいずれかになります: text unicode binary ここに示された値に応じて text_message unicode_message binary_message の要素がJSON形式の中に必要となります。
text_message	条件付き必須	message_type = text の場合はこちらの要素も必要となります。
┗text		GSMアルファベットを使用して送信される通常の7/8ビットテキストメッセージの説明になります。通常では、テキストフィールドは複数の連結メッセージを自動的に分割いたします。しかしながら、手動でメッセージを結合させたい場合は、各セグメントのテキストとそれに対応するUDHを16進文字列で指定して、個々のメッセージを送信してください。連結SMSでの配信時では、最大1520文字となります。改行の際に利用される"/n"は1文字としてカウントされます。注: 連結されたメッセージがメッセージの種類と文字の長さに応じてどのように分割されるかの詳細については、連結されたメッセージの分割セクションを参照してください
┗udh		UDHのための16進文字列
unicode_message	条件付き必須	message_type = Unicode の場合はこちらの要素も必要となります。
┗text		これは、UCS-2アルファベットを用いたUnicodeテキストメッセージになります。通常では、テキストフィールドは複数の連結メッセージを自動的に分割いたします。しかしながら、手動でメッセージを結合させたい場合は、各セグメントのテキストとそれに対応するUDHを16進文字列で指定して、個々のメッセージを送信してください。連結SMSでの配信時では、最大660文字となります。改行の際に利用される"/n"は1文字としてカウントされます注: 連結されたメッセージがメッセージの種類と文字の長さに応じてどのように分割されるかの詳細については、連結されたメッセージの分割セクションを参照してください
┗udh		UDHのための16進文字列
binary_message	条件付き必須	message_type = binary の場合はこちらの要素も必要となります。
┗body		この説明はバイナリーメッセージについてです。バイナリーメッセージでは自動的に結合されないため、メッセージ本文とUDHコンテンツは単一で140バイトのGSMメッセージに収まる必要があります。
┗udh		UDHのための16進文字列
validity_period	任意	メッセージの有効期限を設定することができます。メッセージが宛先の端末に到達するまで、ネットワーク内でメッセージを滞留させることができる期間を指定できます。期間は時間、分、秒、または、Raw SMPP形式の有効期限文字列で表記することができます。絶対時間または相対時間のどちらかになります。この要素のフィールドでは1つのみを指定することができ、複数指定た場合はリクエストが拒否されます。注：最長有効期限ページにあるMNOごとの値を参照してください。
┗days		日
┗hours		時間
┗minutes		分
┗seconds		秒
┗smpp_validity_period_string		SMPP形式の有効期限 ※応用的な方法となります。詳細については、適切なGSM仕様をご確認ください。 https://smpp.org/SMPP_v3_4_Issue1_2.pdf
delivery_receipts	任意	この要素は、送信されたSMSメッセージの配信結果を確認するために必要になります。配信結果を受信するかしないかを選択することができます。（指定しない場合は、falseに設定されています。）ダウンストリームネットワークでサポートされている場合は、オプションで中間配信結果を確認することもできます。そして、配信結果を確認するためのWebhook URLを指定することもできます。指定した場合、アカウント設定手順の一部として、ダッシュボードで設定されたURLを上書きします。通常、APIリクエストでここに何も指定されていない場合、ダッシュボードのURLが使用されます。
┗required		true または false
┗intermediate_dlr		true または false
┗custom_callback_url		Callback URL は配信レシートを受け取る先になります。例：https://<WEBHOOK URL>
advanced_settings	任意	これらの要素により、送信するメッセージをさらに制御することが可能になります。この値は、特別な用途のために設定する必要がある場合があります。この要素を使用する場合、サポートされている値の範囲内のフィールドとサポートされている値の意味を熟知していることを前提としています。 ※応用的な方法となります。詳細については、適切なGSM仕様をご確認ください。 https://smpp.org/SMPP_v3_4_Issue1_2.pdf
┗message_class		0, 1, 2, 3
┗message_waiting_indicator		1または 2
┗protocol_id		0 から 255
metadata	任意	この要素を使用すると、一意のクライアント証明書をメッセージに添付することができます。この値は、APIレスポンスの中で反映、返信され、メッセージに関連する連続した配信結果のWebhook呼び出しも同様になります。
┗client_reference		client_referenceフィールドはフリーテキスト形式で最大50文字まで含むことができます。

サンプルリクエスト

{
  "from": "sender address",
  "to": "...destination phone number...",
  "message_type": "text",
  "text_message": {
    "text": "...message body goes here..."
  }
  "validity_period": {
    "days": "1",
    "hours": "2", 
    "minutes": "45",
    "seconds": "32"
  }
  "metadata": {
    "client_reference": "client-ref-1",
  }
}

レスポンス： 成功した場合は、APIの呼び出しに対するレスポンスが、JSON形式で200 OKとなります。失敗時のレスポンスの詳細はSMS APIリクエストのエラー/拒否を参照してください。

パラメーター	詳細
result_code	結果コードを参照する。
result_message	結果コードの詳細
client_reference	クライアント証明書はリクエストで指定された時のみ返されます。"client reference" は"Additional/Advanced Options" の下で確認することができます。
from	リクエストの中で送信された送信元ID
to	リクエストの中で送信される送信先電話番号
message_id	自動的に生成されるID

サンプルレスポンス

{
  "result_code": "0",
  "result_message": "Message successfully submitted",
  "client_reference": "...if provided during original request...",
  "message_id": "0000001"
  "how_many_message_parts": 1
}

SMS送信

詳細​

詳細