Messagerie Numéros opt-out

Si vous tentez d'envoyer un message à un numéro qui a choisi de ne plus recevoir de messages du numéro que vous envoyez del'envoi du message sera bloqué et vous recevrez une réponse d'erreur dans le reçu de livraison (API SMS) ou le Webhook d'état (API Messages).

SMS API

Si vous tentez de envoyer un message SMS via l'API SMS où le nombre fixé en tant que to a choisi de ne plus recevoir de messages du numéro défini en tant que fromvous devriez d'abord recevoir une réponse HTTP avec un code d'état de 200et status dans le corps de la réponse avec une valeur de 0. Cela indique que le message a été transmis avec succès. soumis pour livraison. Toutefois, vous devriez recevoir par la suite un POST à l'adresse du webhook que vous avez définie pour recevoir des informations sur les les récépissés de livraison. Le corps de la demande contiendra un status avec une valeur de failed ou rejectedet un err-code avec une valeur de 9. Cette code d'erreur indique que l'utilisateur a demandé à ne pas recevoir de messages du numéro d'envoi.

Exemple de corps de récépissé de livraison

{
   "msisdn": "447700900000",
   "to": "AcmeInc",
   "network-code": "12345",
   "messageId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "price": "0.00000000",
   "status": "failed",
   "scts": "2001011400",
   "err-code": "9",
   "api-key": "abcd1234",
   "message-timestamp": "2020-01-01 12:00:00"
}

Messages API

Si vous tentez de envoyer un SMS ou un MMS via l'API Messages où le nombre fixé en tant que to a choisi de ne plus recevoir de messages du numéro défini en tant que fromvous devriez d'abord recevoir une réponse HTTP avec un code d'état de 202et message_uuid dans le corps de la réponse, avec une valeur correspondant à l'UUID unique du message. Cela indique que le message a été traité avec succès. soumis pour livraison. Toutefois, vous devriez recevoir par la suite un POST à l'adresse du webhook que vous avez définie pour recevoir des informations sur les webhooks d'état. Le corps de la demande contiendra un message_uuid avec une valeur identique à l'UUID dans la réponse HTTP initiale. Le corps de la requête contiendra également un champ status avec une valeur de rejected un champ d'erreur contenant un objet avec des détails sur pourquoi le message a été rejeté. Dans ce cas, l'objet doit avoir une valeur title champ code d'erreur de 1240. Cela indique que l'utilisateur a demandé à ne pas recevoir de messages du numéro d'envoi.

Exemple de message État Corps du webhook

{
   "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "to": "447700900000",
   "from": "447700900001",
   "timestamp": {},
   "status": "rejected",
   "error": {
      "type": "https://developer.vonage.com/api-errors/messages-olympus#1240",
      "title": 1240,
      "detail": "Illegal Number - You tried to send a message to a blocklisted phone number. That is, the user has already sent a STOP opt-out message and no longer wishes to receive messages from you.",
      "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
   },
   "usage": {
      "currency": "EUR",
      "price": "0.0000"
   },
   "client_ref": "string",
   "channel": "sms",
   "destination": {
      "network_code": "12345"
   },
   "sms": {
      "count_total": "1"
   }
}