Webhook приходит на адрес, указанный в поле callbackUrl при создании рассылки, при каждом изменении статуса отправленного сообщения.
Формат webhook'а
{
"id": "e67057c1-e97b-4fb4-b040-7cd81528baa9",
"bulkId": "cc5a20f9-55da-4e5c-932e-cc85c3d36566",
"groupId": "d49144ec-d09d-4e24-99f9-34c5ded7de64",
"flowId": "20689f30-8c7b-45b4-9884-8593fc275aed",
"oldStatus": "PENDING",
"newStatus": "DELIVERED",
"oldStatusCode": 2,
"newStatusCode": 6,
"price": 2.5,
"partCount": 1,
"callbackData": "00001"
}
Описание полей ответа:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | String | Да | Идентификатор сообщения |
bulkId | String | Да | Общий идентификатор всех сообщений из рассылки |
groupId | String | Да | Внутренний идентификатор |
flowId | String | Да | Внутренний идентификатор |
oldStatus | String | Да | Предыдущий статус сообщения |
newStatus | String | Да | Текущий статус сообщения |
oldStatusCode | Int | Да | Предыдущий статус-код сообщения |
newStatusCode | Int | Да | Текущий статус-код сообщения |
price | Int | Да | Стоимость сообщения |
partCount | Int | Да | Количество частей сообщения |
callbackData | String | Да | Значение, переданное в поле callbackData при отправки сообщения |
Список статусов:
| Код статуса | Статус | Описание |
|---|---|---|
| 0 | CREATED | Сообщение успешно обработано, но ещё не отправлено. |
| 1 | SENT | Сообщение успешно отправлено оператору. |
| 2 | PENDING | Сообщение успешно отправлено получателю, но отчёт о доставке ещё не получен. |
| 3 | DELAYED | Сообщение успешно обработано, но его отправка отложена. |
| 4 | QUEUED | Сообщение успешно обработано и поставлено в очередь (flow) на отправку в качестве резервного варианта. |
| 5 | SKIPPED | Сообщение имело статус QUEUED и было отменено из-за успешной доставки предыдущего сообщения очереди (flow). |
| 6 | DELIVERED | Сообщение успешно доставлено получателю. |
| 7 | UNDELIVERED | Сообщение успешно отправлено, но не было доставлено получателю. |
| 8 | CANCELED | Отправка сообщения отменена по запросу клиента. |
| 9 | ERROR | При отправке сообщения возникла непредвиденная ошибка. |
| 10 | PAUSED | Отправка сообщения приостановлена. |
| 11 | READ | Сообщение прочитано. |
| 50 | ERROR | На вашем счету недостаточно средств. |
| 100 | EXPIRED | Сообщение получено и отправлено оператору, но его срок действия истёк. |