Налаштуйте вебхуки, щоб оперативно отримувати від нас дані при настанні будь-яких подій, наприклад, при отриманні статусів доставки або вхідного Viber повідомлення, ці дані не потрібно постійно запитувати по API.
Активувати вебхуки можна в розділі "Вебхуки", де ви можете налаштувати вебхук для потрібної події.
У формі додавання вебхука необхідно вказати коллбек URL, куди ми надсилатимемо дані, вибрати потрібні події, при настанні яких буде спрацьовувати вебхук, ввести секретний ключ безпеки для виключення підробки запитів, додати логін і пароль для HTTP Basic аутентифікації (при необхідності), і вибрати формат даних, що відправляються. На даний момент підтримуються формати JSON та FORM DATA, надіслані методом POST.
З кожним вебхуком будуть надсилатися такі дані:
- id — унікальний ідентифікатор події, що відбулася;
- signature — SHA1 хеш строки, що складається з секретного ключа безпеки та id;
- type — тип події;
- date — дата та час, коли сталася подія;
- try — порядковий номер спроби надсилання даних на випадок, якщо попередні були безуспішними;
- data — масив або об'єкт (залежно від обраного формату даних), що містить дані події;
При надсиланні запиту на коллбек URL, ваш сервер повинен повернути HTTP код 200, що символізує успішну обробку запиту. Всі інші коди будуть розцінюватися нашим сервісом як невдалі запити, тому ми намагатимемося відправити його повторно. Повторні запити буде надіслано через 1 хвилину, потім через 3 хвилини, потім через 5, 10, 15, 20, 30, 60 і 120 хвилин, тобто ми намагатимемося доставити вам дані вебхука протягом 4.5 години, після чого повторні спроби надсилання даних будуть припинені. Ви також зможете зробити повторний виклик вебхука вручну, у панелі користувача.
Типи подій, що підтримуються:
Далі наведено опис структур даних, які будуть відправлені в параметрі data в залежності від типу події.
Отримання статусу доставки SMS, надісланого за допомогою HTTP API
Зазвичай коди помилок відповідають специфікації SMPP, але бувають винятки, коли оператор може мати свій набір кодів помилок. У такому разі ми можемо додатково уточнити у оператора призначення конкретного коду. Якщо Вас цікавить причина відхилення повідомлення, будь ласка, зв'яжіться з нашим відділом підтримки, і ми надішлемо запит оператору.
Опис значень поля status
Отримання статусу доставки SMS, надісланого за допомогою SQL
Отримання статусу доставки SMS, надісланого за допомогою SOAP
Отримання статусу доставки SMS, надісланого за допомогою SMPP
Отримання статусу доставки Viber, надісланого за допомогою HTTP API
Отримання статусу доставки сесійного Viber повідомлення
Отримання вхідного Viber повідомлення
Зверніть увагу, що ця подія може бути сгенерована тільки для повідомлень, у яких включено відстежування кліків (статистика переходів).
