你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Sms - Send

参考

Service:: Communication

API Version:: 2021-03-07

从属于经过身份验证的帐户的电话号码发送短信。

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	用于发送短信的可选配置。

响应

名称	类型	说明
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	发送短信的收件人详细信息。
SmsSendOptions	用于发送短信的可选配置。
SmsSendResponse	成功或多状态发送短信请求的响应。
SmsSendResponseItem	单个收件人的响应。

SendMessageRequest

表示发送消息请求的属性。

名称	类型	说明
from	string	发件人的电话号码，格式为 E.164，由经过身份验证的帐户拥有。
message	string	将发送给收件人的邮件的内容。允许的内容由 RFC 5724 定义。
smsRecipients	SmsRecipient[]	收件人的电话号码，采用 E.164 格式。在此版本中，列表中至少支持 1 个收件人和最多 100 个收件人。
smsSendOptions	SmsSendOptions	用于发送短信的可选配置。

SmsRecipient

发送短信的收件人详细信息。

名称	类型	说明
repeatabilityFirstSent	string	必须由客户端发送，以指定请求是可重复的。 Repeatability-First-Sent 用于指定请求首次 created.eg - 周二，2019 年 3 月 26 日 16：06：51 GMT
repeatabilityRequestId	string	如果指定，则客户端指示请求是可重复的;也就是说，客户端可以使用相同的 Repeatability-Request-ID 多次发出请求，并返回适当的响应，而无需服务器多次执行请求。 Repeatability-Request-ID 的值是一个不透明的字符串，表示客户端生成的 36 个字符的十六进制不区分大小写的 UUID 编码 (GUID) 请求标识符。
to	string	收件人的电话号码，采用 E.164 格式。

SmsSendOptions

用于发送短信的可选配置。

名称	类型	说明
enableDeliveryReport	boolean	启用此标志以在 Azure 资源 EventGrid 上接收此消息的传递报告。
tag	string	使用此字段提供元数据，这些元数据随后会在相应的送达报告中发送回。

SmsSendResponse

成功或多状态发送短信请求的响应。

名称	类型	说明
value	SmsSendResponseItem[]	单个收件人的响应。

SmsSendResponseItem

单个收件人的响应。

名称	类型	说明
errorMessage	string	4xx/5xx/可重复错误时可选的错误消息。
httpStatusCode	integer	HTTP 状态代码。
messageId	string	传出短信的标识符。仅当消息已处理时才存在。
repeatabilityResult	enum: accepted rejected	可重复请求的结果，其中包含接受或拒绝的不区分大小写的值之一。
successful	boolean	指示消息是否已成功处理。
to	string	收件人的电话号码，采用 E.164 格式。

Sms - Send

URI 参数

请求正文

响应

示例

SuccessfulSend

Sample Request

Sample Response

定义

SendMessageRequest

SmsRecipient

SmsSendOptions

SmsSendResponse

SmsSendResponseItem

其他资源