Webhooks
Recevez des rappels en temps réel sur les mises à jour dans Smstools.
Qu'est-ce que les webhooks ?
Les webhooks sont une extension d'une API, mais au lieu que votre code demande des données à Smstools, Smstools vous envoie des données. Les données arrivent dans une requête web à votre application. Les webhooks sont également utilisés pour notifier votre application d'événements tels qu'un appel ou un message entrant. Comme les serveurs Smstools doivent pouvoir envoyer des données à votre application via des webhooks, vous devez configurer un serveur web pour recevoir les requêtes HTTP entrantes. Vous devez également spécifier l'URL de chaque webhook sur votre serveur web afin que les données puissent être envoyées à chacun.
Aperçu des webhooks disponibles
| Type | Description |
|---|---|
| delivery_report | Rapport de livraison après chaque message envoyé. Parfois, il peut y avoir 2 webhooks : d'abord un statut 'soumis' et ensuite un statut 'livré' ou 'non livré'. Parfois, des détails supplémentaires sont disponibles lorsque le message n'a pas été livré. |
| read_report | Confirmation de lecture après la lecture du message. Une confirmation de lecture n'est disponible que pour la Messagerie Sociale ou en utilisant le lien 'Demander un rapport de lecture'. |
| inbox_message | Message entrant. Disponible uniquement si vous utilisez la Messagerie Sociale ou un numéro virtuel. |
Codes de rapport de livraison
| Codes de détails du rapport de livraison | Statut | Explication |
|---|---|---|
| 0 | SUBMITTED | Ce message a été livré avec l'opérateur mais nous n'avons pas reçu de rapport de livraison. |
| 1 | DELIVERED | Ce message a été livré avec succès. |
| 2 | NOT DELIVERED | Ce message n'a pas été livré. Raison possible : le destinataire est hors de portée du réseau, problèmes réseau, destinataire à l'étranger. |
| 3 | BUFFERED | Ce message a été livré avec l'opérateur mais pas avec le destinataire. |
| 4 | REJECTED | Ce message est refusé par l'opérateur. |
| 5 | REJECTED | Informations étendues ci-dessous ! |
| 9 | UNKNOWN | Il n'y a pas de rapports de livraison disponibles pour ce message. |
Codes de détails du rapport de livraison
| Statut | Explication |
|---|---|
| 10 | Le numéro du destinataire est invalide ou inconnu |
| 11 | Le destinataire est temporairement hors de portée de l'opérateur de réseau |
| 12 | Problème lié au téléphone. |
| 13 | Problème de réseau de l'opérateur |
| 14 | Message expiré - raison inconnue |
| 15 | Le destinataire est répertorié sur une liste noire |
| 16 | Problème de contenu du message |
| 17 | Le destinataire ne peut pas être réglé |
| 18 | L'opérateur a refusé cela en raison de spam |
| 19 | L'abonné ne peut pas recevoir de messages premium (bloqué par l'opérateur) |
Codes de détails du rapport de livraison sur le code de réponse 5
| Statut | Explication |
|---|---|
| 2000 | INSUFFICIENT_FUNDS |
| 2001 | TOO_LONG |
| 2002 | TOO_SHORT |
| 2003 | TIMEOUT |
| 2004 | GATEWAY_ISSUES |
| 2005 | INVALID_SENDER |
| 2006 | INVALID_NUMBER |
| 4000 | UNKNOWN |
| 4001 | EMPTY_MESSAGE |
| 4002 | EMPTY_CLIENT |
| 4003 | LOCKED |
| 4004 | BLOCKED |
| 4005 | JOB_FAILED |
| 4006 | DUPLICATE |
| 4007 | INVALID_CONTENT |
Exemple : rapport de livraison
[
{
"webhook_id": "svt1jtrmekgb67ratwa31ptupc",
"webhook_type": "delivery_report",
"username": "myusername",
"message": {
"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
"datetime": "2019-01-01 00:00:00",
"content": "here comes your message body",
"sender": "yoursender",
"receiver": "32470123456",
"reference": "yourref",
"delivery_code": "1", [Possible values: 0,1,2,3,4,9]
"delivery_status": "delivered" [code explanation]
"delivery_code_detail": "10", [delivery code with additional details]
"delivery_code_detail_description": "Unknown Subscriber" [detailed explanation]
}
}
]
Exemple : message entrant
[
{
"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
"webhook_type": "inbox_message",
"username": "myusername",
"message": {
"id": "12345678",
"date": "2019-01-01 00:00:00",
"sender": "sendernumber",
"receiver": "12345678",
"content": "message content",
"type": "sms" [Possible values: sms,whatsapp]
}
"isreply": { [The isreply content will only be added when the message was replied to another message]
"reply": true,
"orig_message_content": "original message content",
"orig_messageid": "985zvqipp73csuuha2079fbshx",
"orig_messagedate": "2019-01-01 00:00:00",
"orig_sender": "32471123456",
"orig_receiver": "12345678",
"orig_reference": ""
}
}
]
Exemple : rapport de confirmation de lecture
[
{
"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
"webhook_type": "read_report",
"username": "myusername",
"message": {
"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
"datetime": "2019-01-01 00:00:00",
"content": "here comes your message body",
"sender": "yoursender",
"receiver": "32470123456",
"reference": "yourref",
"delivery_code": "1",
"delivery_status": "delivered"
"read_status": "message_read",
"read_datetime": "2019-01-01 00:01:00"
}
}
]