Деловая связь без лишних сложностей
Приложения для телефона и компьютераРазработчикамIllyVoIP StatusСправочный центр
Все возможности

Вебхуки

Событие в сервисе. Действие в вашем приложении.

Подключайте события звонков, SMS, контактов и голосовой почты к своему приложению: документированные данные, подписанные запросы и история доставки.

Документация вебхуковКак это работает

События, которые
запускают ваши процессы.

Выберите категорию, чтобы посмотреть документированные события. Это справочник, а не лента событий в реальном времени.

call_initiated

Звонок начинается.

call_ringing

Звонок переходит в стадию вызова.

call_answered

На звонок ответили.

call_completed

Звонок завершён; передаётся итоговая длительность.

Как это работает

Происходит событие.
Ваше приложение реагирует.

IllyVoIP отправляет JSON в POST-запросах на указанный вами адрес обработчика.

Выберите подписки

Создайте обработчик в настройках вебхуков аккаунта. Подпишитесь на нужные приложению события звонков, SMS, контактов или голосовой почты.

Проверяйте перед обработкой

Проверяйте заголовок Illyvoip-Signature с помощью секрета вебхука, временной метки и исходного тела запроса согласно документации.

Подтвердите приём и поставьте в очередь

Быстро верните успешный ответ 2xx. Долгие задачи выполняйте через очередь, чтобы они не задерживали подтверждение доставки.

Учитывайте повторные доставки

Сохраняйте идентификатор события из тела запроса и игнорируйте уже обработанные события. Повторная попытка может доставить то же событие снова.

Учитывайте реальные
условия доставки.

В личном кабинете есть история доставки, а в документации API — форматы данных, подписи и правила повторных попыток.

Разбирайте ошибки
Проверяйте статус доставки, HTTP-ответ и сведения об ошибке, чтобы отличить проблему обработчика от ошибки вашей бизнес-логики.
Разделяйте SMS-потоки
Обработчик может получать события всех или выбранных Sender ID. Каждый подходящий обработчик получает событие; фильтрация не переотправляет старые события.
Храните секреты на сервере
Права управления вебхуками дают доступ к обработчикам, секретам и журналам доставки всего аккаунта. Предоставляйте их осознанно. Актуальная спецификация вебхуков

Полезно
знать.

Задать вопрос команде
Есть ли вебхук для каждого действия в личном кабинете?+

Нет. Используйте каталог событий в документации API. Подписывайтесь только на события, доступные для вашего сценария.

Может ли одно событие прийти несколько раз?+

Да. При повторной доставке сохраняется идентификатор события. Удаляйте дубли по полю id в теле запроса, а не по идентификатору задания доставки.

Какие ошибки приводят к повторной попытке?+

В текущей документации перечислены сетевые ошибки и HTTP-ответы 408, 429 и 5xx. Перенаправления и остальные ответы 4xx прекращают доставку. Перед реализацией обработчика проверьте актуальную спецификацию.

Пусть события помогают работе двигаться дальше.

Начните с актуальной документации событий, затем настройте принимающий обработчик.

Документация вебхуковСвязаться с нами