Получение сообщений App Inbox на вебхук
Вместо того чтобы отправлять запросы через API в нашу систему, чтобы получить сообщения App-Inbox для ваших контактов, вы можете получать список всех доступных App-Inbox сообщений на свой вебхук.
Мы можем настроить максимальное количество сообщений для контактов. Количество по умолчанию – 1000.
Обратите внимание
Мы можем отправлять сообщения на ваш вебхук только для тех контактов, которым назначен externalCustomerId.
Требования к вебхуку
Вам необходимо отправить нам URL вебхука, на который вы хотите получать сообщения, а также базовую авторизацию (необязательно).
HTTP метод | POST |
---|---|
Аутентификация (необязательно) | Базовая |
Формат |
|
Сообщения App-Inbox
Вы будете получать сообщения в следующем формате:
{ "externalCustomerId" : string, // Идентификатор получателя "id" : UUID, // ID интеракции. Используется для присвоения статуса "createdDate" : long, // Метка времени в миллисекундах "title" : text, "content" : text, "image" : string, // URL "link" : string, // URL "category" : string, // Категория сообщения "customData" : string }
JSON
Коды статуса HTTP, приходящие в ответ
Код | Описание |
---|---|
200 OK | Успешная обработка запроса. |
401 Forbidden | Ошибка аутентификации. Система повторно обрабатывает такие запросы. |
429 Too Many Requests | Превышен лимит количества сообщений. Система повторно обрабатывает такие запросы. |
400 Bad Request | Проблема с обработкой полезных данных. Система НЕ обрабатывает повторно такие запросы. |
500 Internal Server Error 502 Bad Gateway 503 Service Unavailable | Временные проблемы обработки. Система повторно обрабатывает такие запросы. |