Webhook – механизм оповещений системы и/или сторонних систем, о событиях телефонии или Виртуальной АТС Ringostat в определённый момент.

При возникновении события, созданный ранее в ЛК, webhook-обработчик отправляет HTTP-запрос с набором параметров на URL, который был указан для этого Webhook.

Если URL, на который отправляется Webhook, недоступен (отвечает не HTTP 200 OK), попыток повторной отправки Webhook на этот URL до получения ожидаемого 200 ОК не будет. Webhook будет отмечен "с ошибкой", его статус отправки и ошибку можно будет просмотреть на странице Проверка ошибок Webhooks

WebHooks - упрощенный вариант rest-событий и rest-команд, не требующий написания приложения. Но, даже не смотря на это, работа с REST — это непростая задача, требующая солидной квалификации от разработчика.

  • Событие – " Входящий звонок "

    • перед звонком;

    • после звонка;

    • после меню оценки звонка;

    • в момент поднятия трубки

    • шаг переадресации

  • Событие – " Исходящий звонок "

    • перед звонком;

    • после звонка;

Создание webhook запроса

В личном кабинете перейдите в раздел Интеграция, затем на страницу Webhooks. Страница содержит таблицу включённых и настроенных интеграций проекта. По умолчанию, добавлен и настроен webhook для Google Analytics.

Чтобы создать новый webhook-запрос нажмите Добавить новую интеграцию

После клика на кнопку будет показано pop-up окно настроек для обработчика.

Типы событий и моменты, для отправки запроса

  • Имя – название webhook или интеграции;

  • URL – адрес обработчика, на который будет отправлен запрос. Стандартные порты: 80 для HTTP и 443 для HTTPS.
    Для установки Webhook на URL с указанным портом можно передавать URL в виде: http://11.111.111.11:80

  • Момент отправки данных – момент события, когда будет отправлен запрос

  • Метод отправки данных:

    • GET – запрос с передачей параметров в адресной строке(URL-адресе запроса);

    • POST – запрос с передачей параметров в теле(body) запроса;

    • PUT – запрос для изменения экземпляра с указанным ID;

    • DELETE – запрос с передачей параметров для удаления экземпляра с указанным ID;

  • Формат отправки данных – формат переданных данных на обработчик запроса.

    • http – отправка параметров в адресной строке(URL-адресе запроса);

    • json – отправка параметров в формате объекта(набор пар ключ/значение) в теле запроса;

    • xml – отправка параметров в формате xml;

  • Формат даты – формат в котором будет отправлена дата

    • default – (2015-06-12 15:52:01)

    • DATE_COOKIE – (Friday, 12-Jun-2015 15:52:01 UTC)

    • DATE_ISO8601 – (2015-06-12T15:52:01+0200)

    • DATE_RFC822 – (Fri, 12 Jun 15 15:52:01 +0200)

    • unixtime – (1434120721)

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

Добавление параметров в Webhook-запрос

Чтобы добавить к webhook-запросу параметры - выберите " Настроить Webhook"(пиктограмма шестерёнки).

Далее, нужно выбрать из списка доступные для передачи параметры в выбранный момент и указать их имя:

На этом создание webhook-запроса завершено.

  1. Событие "Входящий звонок"

  2. Событие "Исходящий звонок"

  3. Проверка ошибок Webhooks

Вы нашли ответ?