Sms - Send

リファレンス

Service:: Communication

API Version:: 2021-03-07

認証されたアカウントに属する電話番号から SMS メッセージを送信します。

POST {endpoint}/sms?api-version=2021-03-07

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	通信リソース (例: ) https://my-resource.communication.azure.com
api-version	query	True	string	呼び出す API のバージョン。

要求本文

名前	必須	型	説明
from	True	string	認証されたアカウントが所有する E.164 形式の送信者の電話番号。
message	True	string	受信者に送信されるメッセージの内容。許容されるコンテンツは RFC 5724 によって定義されます。
smsRecipients	True	SmsRecipient[]	E.164 形式の受信者の電話番号。このバージョンでは、リスト内の 1 つ以上の受信者と最大 100 人の受信者がサポートされています。
smsSendOptions		SmsSendOptions	SMS メッセージを送信するためのオプションの構成。

応答

名前	型	説明
202 Accepted	SmsSendResponse	同意

例

SuccessfulSend

Sample Request

HTTP

POST https://contoso.communication.azure.com//sms?api-version=2021-03-07

{
  "from": "+18001110000",
  "smsRecipients": [
    {
      "to": "+11234567890"
    },
    {
      "to": "+11234567891"
    },
    {
      "to": "+112345678901"
    },
    {
      "to": "+11234567892"
    },
    {
      "to": "+11234567893",
      "repeatabilityRequestId": "fda6d242-46aa-4247-8bf6-619a1206f9c3",
      "repeatabilityFirstSent": "Mon, 01 Apr 2019 06:22:03 GMT"
    },
    {
      "to": "+11234567894",
      "repeatabilityRequestId": "fda6d242-46aa-4247-8bf6-619a1206f9c3"
    }
  ],
  "message": "Hello world!",
  "smsSendOptions": {
    "enableDeliveryReport": true,
    "tag": "testSmsRequest"
  }
}

Sample Response

Status code:: 202

{
  "value": [
    {
      "to": "+11234567890",
      "messageId": "Outgoing_20200610203725bfd4ba70-70bf-4f77-925d-c0bdb5161bb3",
      "httpStatusCode": 202,
      "successful": true
    },
    {
      "to": "+11234567891",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822",
      "httpStatusCode": 202,
      "successful": true
    },
    {
      "to": "+112345678901",
      "httpStatusCode": 400,
      "errorMessage": "Invalid To phone number format.",
      "successful": false
    },
    {
      "to": "+11234567892",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822",
      "httpStatusCode": 503,
      "errorMessage": "ServiceUnavailable",
      "successful": false
    },
    {
      "to": "+11234567893",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822_noam",
      "httpStatusCode": 202,
      "repeatabilityResult": "accepted",
      "successful": true
    },
    {
      "to": "+11234567894",
      "messageId": "Outgoing_2020061020025100d1-d07e-4b19-b25d-13525d552822",
      "httpStatusCode": 400,
      "repeatabilityResult": "rejected",
      "errorMessage": "Request sent with Invalid DateTime value for repeatability-first-sent. Expected is DateTime ,RFC1123 pattern.",
      "successful": false
    }
  ]
}

定義

名前	説明
SendMessageRequest	メッセージ送信要求のプロパティを表します。
SmsRecipient	SMS メッセージを送信するための受信者の詳細。
SmsSendOptions	SMS メッセージを送信するためのオプションの構成。
SmsSendResponse	成功または複数の状態に対する応答は、Sms 要求を送信します。
SmsSendResponseItem	1 人の受信者に対する応答。

SendMessageRequest

メッセージ送信要求のプロパティを表します。

名前	型	説明
from	string	認証されたアカウントが所有する E.164 形式の送信者の電話番号。
message	string	受信者に送信されるメッセージの内容。許容されるコンテンツは RFC 5724 によって定義されます。
smsRecipients	SmsRecipient[]	E.164 形式の受信者の電話番号。このバージョンでは、リスト内の 1 つ以上の受信者と最大 100 人の受信者がサポートされています。
smsSendOptions	SmsSendOptions	SMS メッセージを送信するためのオプションの構成。

SmsRecipient

SMS メッセージを送信するための受信者の詳細。

名前	型	説明
repeatabilityFirstSent	string	要求が繰り返し可能であることを指定するには、クライアントから送信する必要があります。 Repeatability-First-Sent は、要求が最初の日時を指定するために使用 created.eg - 2019 年 3 月 26 日 (火) 16:06:51 GMT
repeatabilityRequestId	string	指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じ Repeatability-Request-ID を使用して要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Repeatability-Request-ID の値は、クライアントによって生成された、36 文字の 16 進数の UUID (GUID) エンコード、要求の識別子を表す不透明な文字列です。
to	string	E.164 形式の受信者の電話番号。

SmsSendOptions

SMS メッセージを送信するためのオプションの構成。

名前	型	説明
enableDeliveryReport	boolean	このフラグを有効にして、Azure Resource EventGrid でこのメッセージの配信レポートを受信します。
tag	string	このフィールドを使用して、対応する配信レポートに送り返されるメタデータを指定します。

SmsSendResponse

成功または複数の状態に対する応答は、Sms 要求を送信します。

名前	型	説明
value	SmsSendResponseItem[]	1 人の受信者に対する応答。

SmsSendResponseItem

1 人の受信者に対する応答。

名前	型	説明
errorMessage	string	4xx/5xx/反復可能エラーの場合のオプションのエラーメッセージ。
httpStatusCode	integer	HTTP 状態コード。
messageId	string	送信 SMS メッセージの識別子。メッセージが処理された場合にのみ存在します。
repeatabilityResult	enum: accepted rejected	大文字と小文字を区別しない値のいずれかが受け入れられるか拒否された反復可能な要求の結果。
successful	boolean	メッセージが正常に処理されたかどうかを示します。
to	string	E.164 形式の受信者の電話番号。

Share via

Sms - Send

URI パラメーター

要求本文

応答

例

SuccessfulSend

Sample Request

Sample Response

定義

SendMessageRequest

SmsRecipient

SmsSendOptions

SmsSendResponse

SmsSendResponseItem

その他のリソース