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	Ответ для одного получателя.

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- Вт, 26 марта 2019 г. 16:06:51 GMT
repeatabilityRequestId	string	Если этот параметр указан, клиент указывает, что запрос является повторяемым; то есть клиент может выполнить запрос несколько раз с одинаковым значением Repeatability-Request-ID и получить соответствующий ответ без того, чтобы сервер несколько раз не выполнял запрос. Значение параметра Repeatability-Request-ID — это непрозрачная строка, представляющая созданное клиентом шестнадцатеричное 36-значное шестнадцатеричное кодирование идентификатора UUID (GUID) для запроса без учета регистра.
to	string	Номер телефона получателя в формате E.164.

SmsSendOptions

Необязательная конфигурация для отправки SMS-сообщений.

Имя	Тип	Описание
enableDeliveryReport	boolean	Включите этот флаг, чтобы получать отчет о доставке этого сообщения в Azure Resource EventGrid.
tag	string	Используйте это поле для предоставления метаданных, которые затем будут отправлены обратно в соответствующий отчет о доставке.

SmsSendResponse

Ответ для успешного или нескольких состояний отправки SMS-запроса.

Имя	Тип	Описание
value	SmsSendResponseItem[]	Ответ для одного получателя.

SmsSendResponseItem

Ответ для одного получателя.

Имя	Тип	Описание
errorMessage	string	Необязательное сообщение об ошибке в случае ошибок 4xx/5xx/повторяемых ошибок.
httpStatusCode	integer	Код состояния HTTP.
messageId	string	Идентификатор исходящего sms-сообщения. Отображается только в том случае, если сообщение обработано.
repeatabilityResult	enum: accepted rejected	Результат повторяемого запроса с одним из принятых или отклоненных значений без учета регистра.
successful	boolean	Указывает, успешно ли обработано сообщение.
to	string	Номер телефона получателя в формате E.164.

Поделиться через