Вебхуки
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 - Ожидание СМС
- 2 - SMS, принятые по телефону
- 3 - В очереди для отправки. 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
- 6 - Отправленное SMS по телефону
- 7 - SMS доставлено
- 8 - SMS не было доставлено
- 9 - SMS не отправлено вовсе - обобщенный сбой. (Читайте что делать с этой ошибкой здесь)
- Другое, меньше распространенных ошибок:
- 10 - SMS не отправлено - No Service
- 11 - SMS не отправлено - Null PDU
- 12 - SMS не отправлено - Radio Off
- 100, 101 - SMS не отправлено - NOT ALLOWED. (Разрешения для отправки SMS в приложении не были предоставлены)
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.