Sms - Send

Referência

Serviço:: Communication

Versão da API:: 2021-03-07

Envia uma mensagem SMS de um número de telefone que pertence à conta autenticada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	O recurso de comunicação, por exemplo, https://my-resource.communication.azure.com
api-version	query	True	string	Versão da API a ser invocada.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
from	True	string	O número de telefone do remetente no formato E.164 que pertence à conta autenticada.
message	True	string minLength: 0 maxLength: 2048	O conteúdo da mensagem que será enviada ao destinatário. O conteúdo permitido é definido pelo RFC 5724.
smsRecipients	True	SmsRecipient[]	O número de telefone do destinatário no formato E.164. Nesta versão, há suporte para no mínimo 1 e até 100 destinatários na lista.
smsSendOptions		SmsSendOptions	Configuração opcional para enviar mensagens SMS.

Respostas

Nome	Tipo	Description
202 Accepted	SmsSendResponse	Aceitado

Exemplos

SuccessfulSend

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:: 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
    }
  ]
}

Definições

Nome	Description
SendMessageRequest	Representa as propriedades de uma solicitação de mensagem de envio.
SmsRecipient	Detalhes do destinatário para enviar mensagens SMS.
SmsSendOptions	Configuração opcional para enviar mensagens SMS.
SmsSendResponse	Resposta para uma solicitação sms de envio bem-sucedida ou de vários status.
SmsSendResponseItem	Resposta para um único destinatário.

SendMessageRequest

Objeto

Representa as propriedades de uma solicitação de mensagem de envio.

Nome	Tipo	Description
from	string	O número de telefone do remetente no formato E.164 que pertence à conta autenticada.
message	string minLength: 0 maxLength: 2048	O conteúdo da mensagem que será enviada ao destinatário. O conteúdo permitido é definido pelo RFC 5724.
smsRecipients	SmsRecipient[]	O número de telefone do destinatário no formato E.164. Nesta versão, há suporte para no mínimo 1 e até 100 destinatários na lista.
smsSendOptions	SmsSendOptions	Configuração opcional para enviar mensagens SMS.

SmsRecipient

Objeto

Detalhes do destinatário para enviar mensagens SMS.

Nome	Tipo	Description
repeatabilityFirstSent	string	DEVE ser enviado por clientes para especificar que uma solicitação é repetível. Repetibilidade-First-Sent é usado para especificar a data e hora em que a solicitação foi created.eg- Ter, 26 mar 2019 16:06:51 GMT
repeatabilityRequestId	string	Se especificado, o cliente direciona que a solicitação seja repetível; ou seja, o cliente pode fazer a solicitação várias vezes com a mesma RepetiçãoRequest-ID e obter uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor daRequest-ID de repetição é uma cadeia de caracteres opaca que representa uma codificação hexadecimal sem diferenciação de maiúsculas e minúsculas de 36 caracteres gerada pelo cliente de um GUID (UUID), identificador para a solicitação.
to	string	O número de telefone do destinatário no formato E.164.

SmsSendOptions

Objeto

Configuração opcional para enviar mensagens SMS.

Nome	Tipo	Description
enableDeliveryReport	boolean	Habilite esse sinalizador para receber um relatório de entrega para esta mensagem no EventGrid de Recurso do Azure.
tag	string	Use esse campo para fornecer metadados que serão enviados novamente no Relatório de Entrega correspondente.

SmsSendResponse

Objeto

Resposta para uma solicitação sms de envio bem-sucedida ou de vários status.

Nome	Tipo	Description
value	SmsSendResponseItem[]	Resposta para um único destinatário.

SmsSendResponseItem

Objeto

Resposta para um único destinatário.

Nome	Tipo	Description
errorMessage	string	Mensagem de erro opcional no caso de erros 4xx/5xx/repetíveis.
httpStatusCode	integer	Código de status HTTP.
messageId	string	O identificador da mensagem sms de saída. Presente somente se a mensagem for processada.
repeatabilityResult	enum: accepted rejected	O resultado de uma solicitação repetível com um dos valores que não diferenciam maiúsculas de minúsculas aceitos ou rejeitados.
successful	boolean	Indica se a mensagem é processada com êxito ou não.
to	string	O número de telefone do destinatário no formato E.164.

Compartilhar via

Sms - Send

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

SuccessfulSend

Solicitação de exemplo

Resposta de exemplo

Definições

SendMessageRequest

SmsRecipient

SmsSendOptions

SmsSendResponse

SmsSendResponseItem