Un webhook (ou callback) permet à notre plateforme d'envoyer à votre application des informations sur un événement donné (comme la réception d'un nouveau SMS entrant). Cela se produit en temps réel, ce qui vous permet d'exploiter la plateforme pour créer vos propres solutions de messagerie bidirectionnelle en envoyant des SMS via l'API et en traitant les réponses via les webhooks.
Événements courants que vous voudrez suivre :
- SMS -> Réception de SMS
- SMS -> L'opt-out s'est produit
- Rapports de livraison -> Le message a été livré
- Rapports de livraison -> Le message a expiré
Pour créer un webhook, connectez-vous, allez dans Paramètres > API et sélectionnez l'onglet Webhooks. Cliquez ensuite sur « Nouveau webhook » :
Configurez les bases de votre webhook :
- Sélectionnez le(s) événement(s) que vous souhaitez suivre (par exemple SMS -> Réception de SMS)
- Sélectionnez la méthode HTTP que vous souhaitez que nous envoyions à votre application (par exemple POST)
- Saisissez l'URL où vous souhaitez traiter l'événement (par exemple https://yourapplication.com/sms/inbound-sms)
Ensuite, indiquez les en-têtes que vous souhaitez présenter dans votre requête. Pour ajouter des lignes d'en-tête supplémentaires, il suffit de cliquer sur « Ajouter un en-tête » :
Ensuite, spécifiez le contenu à transmettre dans le contenu de la requête au point d'accès spécifié.
Une bonne valeur par défaut à spécifier serait la suivante :
id |
$mtID |
accountId |
$accountId |
sourceAddress |
$sourceAddress |
destinationAddress |
$destinationAddress |
messageContent |
$mtContent |
replyContent |
$moContent |
Enfin, cliquez sur « Sauvegarder le webhook » en bas à droite de l'écran.
Dans cet exemple, nous avons créé un webhook qui effectuera l'action POST à https://yourapplication.com/sms/inbound-sms lorsque vous recevez un SMS, comme une requête JSON avec les informations suivantes dans le corps JSON : id, accountId, sourceAddress, destinationAddress, messageContent, replyContent.