Sms - Send

Service:

Communication

API Version:

2021-03-07

從屬於已驗證帳戶的電話號碼傳送SMS訊息。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	通訊資源，例如 https://my-resource.communication.azure.com
api-version	query	True	string	要叫用的 API 版本。

要求本文

名稱	必要	類型	Description
from	True	string	E.164 格式的寄件者電話號碼，由已驗證的帳戶所擁有。
message	True	string	將傳送給收件者的訊息內容。 允許的內容是由 RFC 5724 所定義。
smsRecipients	True	SmsRecipient[]	收件者的電話號碼，格式為E.164。 在此版本中，清單中至少支援1和最多100位收件者。
smsSendOptions		SmsSendOptions	傳送SMS訊息的選擇性設定。

回應

名稱	類型	Description
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
    }
  ]
}

定義

名稱	Description
SendMessageRequest	表示傳送訊息要求的屬性。
SmsRecipient	傳送簡訊的收件者詳細數據。
SmsSendOptions	傳送SMS訊息的選擇性設定。
SmsSendResponse	成功或多重狀態的回應會傳送簡訊要求。
SmsSendResponseItem	單一收件者的回應。

SendMessageRequest

表示傳送訊息要求的屬性。

名稱	類型	Description
from	string	E.164 格式的寄件者電話號碼，由已驗證的帳戶所擁有。
message	string	將傳送給收件者的訊息內容。 允許的內容是由 RFC 5724 所定義。
smsRecipients	SmsRecipient[]	收件者的電話號碼，格式為E.164。 在此版本中，清單中至少支援1和最多100位收件者。
smsSendOptions	SmsSendOptions	傳送SMS訊息的選擇性設定。

SmsRecipient

傳送簡訊的收件者詳細數據。

名稱	類型	Description
repeatabilityFirstSent	string	必須由客戶端傳送，以指定要求可重複。 Repeatability-First-Sent 可用來指定要求第一次 created.eg 的日期和時間- Tue， 26 Mar 2019 16：06：51 GMT
repeatabilityRequestId	string	如果指定，用戶端會指示要求可重複;也就是說，用戶端可以使用相同的 Repeatability-Request-ID 多次提出要求，並取得適當的回應，而不需要伺服器多次執行要求。 Repeatability-Request-ID 的值是不透明的字串，代表客戶端產生的 36 個字元十六進位十六進位不區分大小寫的 UUID 編碼 (GUID) 要求標識符。
to	string	收件者的電話號碼，格式為E.164。

SmsSendOptions

傳送SMS訊息的選擇性設定。

名稱	類型	Description
enableDeliveryReport	boolean	啟用此旗標，以在 Azure Resource EventGrid 上接收此訊息的傳遞報告。
tag	string	使用此欄位來提供元數據，然後傳送回對應的傳遞報表。

SmsSendResponse

成功或多重狀態的回應會傳送簡訊要求。

名稱	類型	Description
value	SmsSendResponseItem[]	單一收件者的回應。

SmsSendResponseItem

單一收件者的回應。

名稱	類型	Description
errorMessage	string	如果發生 4xx/5xx/可重複的錯誤，則為選擇性錯誤訊息。
httpStatusCode	integer	HTTP 狀態代碼。
messageId	string	傳出簡訊的標識碼。 只有在訊息已處理時才存在。
repeatabilityResult	enum: accepted rejected	可重複要求的結果，其中一個不區分大小寫的值已接受或拒絕。
successful	boolean	指出訊息是否成功處理。
to	string	收件者的電話號碼，格式為E.164。