SMS entrants

Pour recevoir des SMS entrants, créez un point de terminaison du webhook et configurez votre Account pour qu'il l'utilise dans l'onglet Paramètres de l'API de l'application Tableau de bord du développeur Vonage.

Tous les messages envoyés à l'un de vos numéros virtuels Vonage sont envoyés à votre webhook à l'aide d'une requête

GET
ou
POST
. Lorsque vous recevez un message sur votre webhook, vous devez envoyer une requête
GET
ou
POST
à votre webhook. 200 OK ou 204 No Content réponse. Si vous ne le faites pas, Vonage considérera que vous n'avez pas reçu le message et le renverra pendant les 24 heures suivantes.

Les messages concaténés nécessitent une attention particulière. Voir aussi messages entrants concaténés.

Anatomie d'un message entrant

Les messages sont envoyés à votre point de terminaison webhook sous la forme d'un objet JSON avec les propriétés suivantes :

Clé Valeur Exigée
type Les valeurs possibles sont les suivantes :
  • text - texte standard
  • unicode - un message texte contenant des caractères Unicode
  • binary - un message binaire
 Oui
to Le numéro de téléphone auquel le message a été envoyé à. Il s'agit de votre numéro virtuel. Oui
msisdn Le numéro de téléphone auquel ce message entrant a été envoyé de. Oui
messageId Identifiant unique de Vonage pour ce message. Oui
message-timestamp Les UTC±00:00 l'heure à laquelle Vonage a commencé à envoyer ce message entrant à votre point de terminaison webhook, dans le format suivant : YYYY-MM-DD HH:MM:SS. Oui
timestamp Les horodatage unix représentation de message-timestamp. Non
nonce Une chaîne aléatoire qui ajoute un élément supplémentaire d'imprévisibilité à la signature de la demande. Vous utilisez la chaîne nonce et timestamp avec votre secret partagé pour calculer et valider la signature des messages entrants. Si vos messages sont signé

Pour les messages de type text ou unicode

Si le type est text ou unicodeles propriétés suivantes apparaissent dans la demande adressée à votre point de terminaison webhook.

Clé Valeur
text Le corps du message pour ce message entrant.
keyword Le premier mot du corps du message. Il est généralement utilisé avec les codes courts.

Pour les messages de type binary

Si le type est binaryles propriétés suivantes apparaissent dans la demande adressée à votre point de terminaison webhook.

Clé Valeur
data Le contenu de ce message
udh Le code hexadécimal en-tête des données de l'utilisateur

Pour les messages entrants concaténés

Si un message envoyé à votre numéro virtuel respecte la longueur maximale autorisée pour un seul message, les propriétés suivantes n'apparaissent pas dans la demande adressée à votre point de terminaison webhook.

Si le message est plus long que le nombre maximum de caractères autorisé dans un seul message, vous recevrez le message en plusieurs parties et les propriétés suivantes apparaîtront dans la demande.

Utiliser le concat-ref, concat-total et concat-part pour construire le message à partir des différentes parties.

Tous les opérateurs ne prennent pas en charge les messages concaténés. Si le transporteur ne prend pas en charge la concaténation, l'option concat ne sera pas présent dans la charge utile.

Clé Valeur
concat true
concat-ref La référence de la transaction. Toutes les parties de ce message partagent ceci concat-ref.
concat-total Le nombre de parties dans ce message concaténé.
concat-part Le numéro de cette partie du message. La première partie du message est 1.