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