SMS Messaging API

1件または複数件の宛先電話番号へSMSを送信します。実装前に API共通仕様を確認してください。

認証コード、通知、プロモーションメッセージを、世界中の宛先電話番号へ柔軟に送信できます。インターフェースは簡潔でありながら十分な表現力を備え、さまざまなSMS送信シナリオに対応します。

SMSで認証コードを送信する場合は、より統合度の高い Send OTP API の利用を推奨します。実装効率と利用者体験の向上につながります。

定義

Action: sms.message.send
HTTP Method: POST
Content-Type: application/json

リクエストパラメータ

Name	Type	Required	Description	Example
to	string \| string[]	Yes	送信先電話番号。E.164形式	+12068800123
signature	string	No	SMS送信者名。2〜16文字	Unimatrix
text	string	No	SMS本文全体。 * `templateId`、`text`、`content` のいずれかは必須	701522 is your verification code, valid for 10 minutes.
content	string	No	SMS本文の主要部。`signature` と結合して最終本文になります。 * `templateId`、`text`、`content` のいずれかは必須	701522 is your verification code, valid for 10 minutes.
templateId	string	No	SMSテンプレートIDまたはカスタムテンプレートコード。 * `templateId`、`text`、`content` のいずれかは必須	pub_verif_en_ttl
templateData	JSON	No	`templateId` と組み合わせて使うテンプレート変数	`{"code": "701522", "ttl": "10"}`

リクエスト例

curl -X POST 'https://api.unimtx.com/?action=sms.message.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+12068800xxx",
  "text": "Your verification code is 204806."
}'

レスポンスパラメータ

Name	Type	Description	Example
code	string	戻り値コード	0
message	string	戻り値メッセージ	Success
data	JSON	結果

Results `data`

Name	Type	Description	Example
recipients	integer	宛先電話番号数	1
messageCount	integer	課金対象メッセージ総数	1
currency	string	通貨	USD
totalAmount	string	合計利用額	0.018900
messages	JSON[]	送信メッセージ詳細

Messages `data.messages`

Name	Type	Description	Example
id	string	メッセージID	c9159d19f394833327e43c8e7285a6b3
to	string	宛先電話番号（E.164）	+12068800123
iso	string	国コード（ISO2）	US
cc	string	国番号	1
parts	integer	分割通数	1
price	string	利用額	0.018900

レスポンス例

成功レスポンス例

Status Code: 200, Response Body:

{
  "code": "0",
  "message": "Success",
  "data": {
    "recipients": 1,
    "messageCount": 1,
    "totalAmount": "0.018900",
    "messages": [
      {
        "id": "c9159d19f394833327e43c8e7285a6b3",
        "to": "+12068800123",
        "iso": "US",
        "cc": "1",
        "parts": 1,
        "price": "0.018900"
      }
    ]
  }
}

失敗レスポンス例

Status Code: 400, Response Body:

{
  "code": "105400",
  "message": "InsufficientFunds"
}