Sms - Send

Référence

Service:: Communication

Version d'API:: 2021-03-07

Envoie un SMS à partir d’un numéro de téléphone qui appartient au compte authentifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	La ressource de communication, par exemple https://my-resource.communication.azure.com
api-version	query	True	string	Version de l’API à appeler.

Corps de la demande

Nom	Obligatoire	Type	Description
from	True	string	Numéro de téléphone de l’expéditeur au format E.164 appartenant au compte authentifié.
message	True	string	Contenu du message qui sera envoyé au destinataire. Le contenu autorisé est défini par la RFC 5724.
smsRecipients	True	SmsRecipient[]	Numéro de téléphone du destinataire au format E.164. Dans cette version, un minimum de 1 et jusqu’à 100 destinataires dans la liste sont pris en charge.
smsSendOptions		SmsSendOptions	Configuration facultative pour l’envoi de sms.

Réponses

Nom	Type	Description
202 Accepted	SmsSendResponse	Accepté

Exemples

SuccessfulSend

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
    }
  ]
}

Définitions

Nom	Description
SendMessageRequest	Représente les propriétés d’une demande d’envoi de message.
SmsRecipient	Détails du destinataire pour l’envoi de sms.
SmsSendOptions	Configuration facultative pour l’envoi de sms.
SmsSendResponse	Réponse pour une demande d’envoi de SMS réussie ou de plusieurs status.
SmsSendResponseItem	Réponse pour un seul destinataire.

SendMessageRequest

Représente les propriétés d’une demande d’envoi de message.

Nom	Type	Description
from	string	Numéro de téléphone de l’expéditeur au format E.164 appartenant au compte authentifié.
message	string	Contenu du message qui sera envoyé au destinataire. Le contenu autorisé est défini par la RFC 5724.
smsRecipients	SmsRecipient[]	Numéro de téléphone du destinataire au format E.164. Dans cette version, un minimum de 1 et jusqu’à 100 destinataires dans la liste sont pris en charge.
smsSendOptions	SmsSendOptions	Configuration facultative pour l’envoi de sms.

SmsRecipient

Détails du destinataire pour l’envoi de sms.

Nom	Type	Description
repeatabilityFirstSent	string	DOIT être envoyé par les clients pour spécifier qu’une demande est reproductible. La répétabilité-Premier envoi permet de spécifier la date et l’heure de la première demande created.eg- mar 26 mar 2019 16 :06 :51 GMT
repeatabilityRequestId	string	S’il est spécifié, le client indique que la demande est reproductible ; Autrement dit, le client peut effectuer la demande plusieurs fois avec le même Repeatability-Request-ID et obtenir une réponse appropriée sans que le serveur n’exécute la demande plusieurs fois. La valeur de Repeatability-Request-ID est une chaîne opaque représentant un encodage hexadécimal de 36 caractères sans respect de la casse d’un identificateur GUID (UUID) généré par le client.
to	string	Numéro de téléphone du destinataire au format E.164.

SmsSendOptions

Configuration facultative pour l’envoi de sms.

Nom	Type	Description
enableDeliveryReport	boolean	Activez cet indicateur pour recevoir un rapport de remise pour ce message sur Azure Resource EventGrid.
tag	string	Utilisez ce champ pour fournir des métadonnées qui seront ensuite renvoyées dans le rapport de remise correspondant.

SmsSendResponse

Réponse pour une demande d’envoi de SMS réussie ou de plusieurs status.

Nom	Type	Description
value	SmsSendResponseItem[]	Réponse pour un seul destinataire.

SmsSendResponseItem

Réponse pour un seul destinataire.

Nom	Type	Description
errorMessage	string	Message d’erreur facultatif en cas d’erreurs 4xx/5xx/reproductibles.
httpStatusCode	integer	Code d’état HTTP.
messageId	string	Identificateur du message SMS sortant. Présente uniquement si le message est traité.
repeatabilityResult	enum: accepted rejected	Résultat d’une requête reproductible avec l’une des valeurs qui ne respectent pas la casse acceptées ou rejetées.
successful	boolean	Indique si le message est traité avec succès ou non.
to	string	Numéro de téléphone du destinataire au format E.164.

Partager via