Webhooks
Use webhooks to receive message events immediately in your system.
Two webhook types are available:
- Delivery status webhook for outgoing messages.
- Incoming message webhook for SMS and other supported channels.
1. Delivery status webhook
Configure this webhook in device settings to receive status updates without polling the API.
{
"sms_id": int,
"status_id": int,
"status_message": string,
"sendto": string,
"senttime": datetime,
"channel_id": int,
"device_id": int
}
- 1 - En attente de SMS
- 2 - SMS pris par téléphone
- 3 - En attente d'envoi. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
- 5 - SMS entrants
- 6 - SMS envoyé par téléphone
- 7 - Le SMS a été envoyé
- 8 - Le SMS n'a pas été envoyé
- 9 - SMS n'a pas du tout été envoyé - Échec générique. (Lire ce qu'il faut faire avec cette erreur ici)
- Autre, erreurs moins courantes:
- 10 - SMS non envoyé - No Service
- 11 - SMS non envoyé - Null PDU
- 12 - SMS non envoyé - Radio Off
- 100, 101 - SMS non envoyé - NOT ALLOWED. (Les autorisations pour l'envoi de SMS dans l'application n'ont pas été accordées)
2. Incoming message webhook
Configure this webhook to forward incoming messages to your CRM, helpdesk or backend.
{
"address": string,
"date": datetime,
"date_sent": datetime,
"body": string,
"internal_id": int,
"channel_id": int,
"sms_id": int,
"device_id": int,
"device_name": string
}
Webhook availability depends on your subscription plan.