Webhooks
Ce qu'envoie le webhook
Un webhook est une adresse de votre côté à laquelle BulkGate signale ce qu'il est
advenu de vos messages. Le portail l'appelle Rapports de livraison, mais il y envoie
deux choses à la fois :
| Ce qui arrive | Comment le reconnaître |
|---|---|
| Rapport de livraison | Un enregistrement avec le statut d'un message envoyé et son smsID |
| SMS entrant (une réponse) | Un enregistrement avec status 10, l'expéditeur dans from et le texte du message |
Il ne s'agit donc pas de deux réglages distincts — une seule adresse traite à la fois les rapports de livraison et les réponses.
Le format des données dépend de l'activation de l'envoi groupé :
| Mode | Comment les données arrivent | Format décrit sur |
|---|---|---|
| par défaut | Une requête par message, en GET | Confirmations de livraison |
Rapports de livraison groupés - requête groupée |
Un lot d'enregistrements, en POST avec application/json |
Confirmations de livraison groupées |
Où se configure le webhook
L'emplacement dépend de l'interface que vous utilisez. Les deux premières étapes
sont identiques dans tous les cas — dans le menu du portail, cliquez sur
Modules et API et ouvrez la carte de votre application dans Mes API et modules.
| Interface | Où dans le détail de l'application |
|---|---|
| API HTTP | L'onglet Réglages, la partie Webhooks, la carte Rapports de livraison |
Email > SMS |
Uniquement Rapports de livraison par e-mail — les rapports arrivent par e-mail, et non sur une URL |
Comment activer le webhook
La carte indique si quelque chose est configuré. Tant que ce n'est pas le cas, elle
affiche Vous n'avez aucun paramètre. et un bouton Configurer.
Le bouton Configurer (ou Modifier, si vous avez déjà des paramètres) ouvre la
fenêtre Paramètres des rapports de livraison.
Saisissez une adresse commençant par http:// ou https:// dans le champ URL delivery reports — le portail n'accepte aucune autre écriture. Trois cases à cocher
l'accompagnent :
| Option | Ce qu'elle fait |
|---|---|
Désactiver la vérification de la disponibilité des URL |
Le portail ne vérifie pas que l'adresse répond avant l'enregistrement |
Prévenir en cas d 'erreur |
Un rapport n'arrive que pour un message en échec |
Rapports de livraison groupés - requête groupée |
Les rapports arrivent par lots au lieu d'un par un |
Vous enregistrez la configuration avec le bouton Enregistrer.
L'envoi groupé est utile pour les volumes élevés — au lieu d'une requête par message, une seule requête arrive avec un tableau d'enregistrements. Le format des lots est décrit sur Confirmations de livraison groupées.
Une fois le webhook configuré, la carte affiche trois lignes — URL avec l'adresse, et
une icône pour Prévenir en cas d 'erreur et pour Rapports de livraison groupés - requête groupée, qui
indique si l'option est activée.
Comment supprimer le webhook
La flèche à côté du bouton Modifier ouvre un menu avec l'option Effacer. La fenêtre
de confirmation Effacer les paramètres vous avertit que vous perdrez vos paramètres
de rapports de livraison et qu'ils cesseront d'arriver.
La suppression du webhook arrête aussi les messages entrants — les réponses à vos SMS n'ont alors plus d'adresse où être livrées.
Merci pour votre retour.