Sms - Send

Referencia

Servicio:: Communication

Versión de la API:: 2021-03-07

Envía un mensaje SMS desde un número de teléfono que pertenece a la cuenta autenticada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	El recurso de comunicación, por ejemplo. https://my-resource.communication.azure.com
api-version	query	True	string	Versión de la API que se va a invocar.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
from	True	string	Número de teléfono del remitente en formato E.164 que pertenece a la cuenta autenticada.
message	True	string	Contenido del mensaje que se enviará al destinatario. El contenido permitido se define mediante RFC 5724.
smsRecipients	True	SmsRecipient[]	Número de teléfono del destinatario en formato E.164. En esta versión, se admiten un mínimo de 1 y hasta 100 destinatarios en la lista.
smsSendOptions		SmsSendOptions	Configuración opcional para enviar mensajes SMS.

Respuestas

Nombre	Tipo	Description
202 Accepted	SmsSendResponse	Aceptado

Ejemplos

SuccessfulSend

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
SendMessageRequest	Representa las propiedades de una solicitud de mensaje de envío.
SmsRecipient	Detalles del destinatario para enviar mensajes SMS.
SmsSendOptions	Configuración opcional para enviar mensajes SMS.
SmsSendResponse	Respuesta para una solicitud sms de envío correcta o de varios estados.
SmsSendResponseItem	Respuesta para un único destinatario.

SendMessageRequest

Representa las propiedades de una solicitud de mensaje de envío.

Nombre	Tipo	Description
from	string	Número de teléfono del remitente en formato E.164 que pertenece a la cuenta autenticada.
message	string	Contenido del mensaje que se enviará al destinatario. El contenido permitido se define mediante RFC 5724.
smsRecipients	SmsRecipient[]	Número de teléfono del destinatario en formato E.164. En esta versión, se admiten un mínimo de 1 y hasta 100 destinatarios en la lista.
smsSendOptions	SmsSendOptions	Configuración opcional para enviar mensajes SMS.

SmsRecipient

Detalles del destinatario para enviar mensajes SMS.

Nombre	Tipo	Description
repeatabilityFirstSent	string	LOS CLIENTES DEBEN enviarse para especificar que se puede repetir una solicitud. Repeatability-First-Sent se usa para especificar la fecha y hora en la que la solicitud se created.eg- Tue, 26 mar 2019 16:06:51 GMT
repeatabilityRequestId	string	Si se especifica, el cliente dirige que se puede repetir la solicitud; Es decir, el cliente puede realizar la solicitud varias veces con el mismo Repeatability-Request-ID y obtener una respuesta adecuada sin que el servidor ejecute la solicitud varias veces. El valor de Repeatability-Request-ID es una cadena opaca que representa una codificación hexadecimal hexadecimal de 36 caracteres generada por el cliente que no distingue mayúsculas de minúsculas de un UUID (GUID), identificador de la solicitud.
to	string	Número de teléfono del destinatario en formato E.164.

SmsSendOptions

Configuración opcional para enviar mensajes SMS.

Nombre	Tipo	Description
enableDeliveryReport	boolean	Habilite esta marca para recibir un informe de entrega para este mensaje en Azure Resource EventGrid.
tag	string	Use este campo para proporcionar metadatos que se devolverán en el informe de entrega correspondiente.

SmsSendResponse

Respuesta para una solicitud sms de envío correcta o de varios estados.

Nombre	Tipo	Description
value	SmsSendResponseItem[]	Respuesta para un único destinatario.

SmsSendResponseItem

Respuesta para un único destinatario.

Nombre	Tipo	Description
errorMessage	string	Mensaje de error opcional en caso de errores 4xx/5xx/repeatable.
httpStatusCode	integer	Código de estado HTTP.
messageId	string	Identificador del mensaje Sms saliente. Solo está presente si se procesa el mensaje.
repeatabilityResult	enum: accepted rejected	Resultado de una solicitud repetible con uno de los valores que no distinguen mayúsculas de minúsculas aceptados o rechazados.
successful	boolean	Indica si el mensaje se procesa correctamente o no.
to	string	Número de teléfono del destinatario en formato E.164.

Compartir a través de