Веб-хук (webhook) — это отправка запросов по событиям из onlinePBX. Запросы уведомляют сторонние сервисы об изменениях в АТС. Позволяют отслеживать звонки, их состояние и другие события onlinePBX — информация отправляется на указанный URL-адрес. Веб-хуки могут использоваться для интеграции.
Подключение
Для подключения веб-хуков необходимо указать URL-адрес, куда будут отправляться POST-запросы. Для этого в панели управления onlinePBX перейдите в Интеграция > Webhooks, нажмите «+ Добавить».
Появится строка с настройкой. Введите URL-адрес, а также выберите, какие именно события хотите получать. На выбор есть шесть вариантов. Нажмите «Сохранить».
| Expand | ||
|---|---|---|
| ||
|
| Note |
|---|
| Если в поле «URL-адрес» ввести адрес с протоколом https://, убедитесь, что на указанном адресе есть действительный сертификат безопасности (SSL-сертификат). |
| Note |
|---|
| В случае получения ошибки или отсутствия ответа при передаче POST-запросов, наш сервис отправляет запрос повторно еще два раза с интервалом в пять секунд. |
Статус
Для тестирования веб-хуков мы добавили в выпадающее меню функцию «Тест». По клику будет совершаться отправка тестового веб-хука. При получении ошибки, её номер или описание покажется в подсказке. В разделе «История» указывается, что был проведен тест.
Три статуса подключения:
- Серый «Не подключен» — показывается до отправки первого события.
- Зелёный «Подключен» — после успешного прохождения теста.
- Красный «Отключен» — при получении ошибки в ходе теста.
История
Сервис хранит историю отправки веб-хуков и ответы от сервера. Можно посмотреть в правой части страницы.
Если произошла ошибка во время передачи, рядом с полем «Тип» появится значок ошибки. При наведении покажется статус, полученный от сервера, куда был отправлен веб-хук.
| Note |
|---|
История | История отображается не моментально. Обновите страницу, чтобы увидеть актуальную историю. |
Примеры запросов
Начался звонок
{ "x-roistat-marker": "google12_g_50000997109_279581000041_%D1%85%D1%80%D0%B0%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5+%D0%B2%D0%B5%D1%89%D0%B5%D0%B9+%D0%B2+%D0%BC%D0%BE%D1%81%D0%BA%D0%B2%D0%B5" "x-roistat": "444308" |
|---|
Если | Note |
|---|
| Если в аккаунте onlinePBX зарегистрирован внешний номер от Roistat, — не будет передаваться |
| параметр x-roistat. |
При | Note |
|---|
| При использовании схемы Оператор > Roistat > Оператор > onlinePBX, не будут передаваться параметры x-roistat-marker и x-roistat. |
Ответили на звонок
{ } |
|---|
Завершился звонок
{ } |
|---|
| Note |
|---|
Время | Время жизни ссылки на скачивание разговора — 200 секунд. |
Пропущенный звонок
{ "domain":"onlinepbx.ru", } |
|---|
Дозвон до пользователя
{ } |
|---|
Перевод звонка
{ |
|---|
| Note |
|---|
Параметры | Параметры x-roistat-marker и x-roistat отправляются только при рабочей интеграции с сервисом Roistat. |
Список переменных и описание
| № | Переменная | Пример значения переменной | Описание переменной |
|---|---|---|---|
| 1 | domain | example.onpbx.ru | Домен, в котором состоялось событие. |
| 2 | event | call_end / call_answered / call_start / call_user_start | Тип события. |
| 3 | direction | inbound / outbound / local | Тип звонка (входящий/исходящий/внутренний). |
| 4 | uuid | 5921a027-c22f-4351-b495-30a49f00e4e1 | Уникальный идентификатор сессии. |
| 5 | caller | +79510057057 / 510@onlinepbx.ru | Звонящий. |
| 6 | callee | 79827347182 / 102 | Кому звонили. |
| 7 | from_domain | examplefrom.onpbx.ru | Домен звонящего. |
| 8 | to_domain | exampleto.onpbx.ru | Домен того, кому звонили. |
| 9 | gateway | 74922296721 | Транк, на/с которого позвонили. |
| 10 | date | 1527578 | Дата в формате UNIX. |
| 11 | call_duration | 159 | Общая длительность звонка (сек.). |
| 12 | dialog_duration | 145 | Длительность разговора (сек.). |
| 13 | hangup_cause | NORMAL_CLEARING Полный список результатов. | Причина завершения звонка. |
| 14 | hangup_by | caller / callee | Кто инициировал завершение вызова. |
| 15 | x-roistat-marker | google12_g_50000997109_279581000041_%D1%85%D1%80%D0%B0%D0%BD %D0%B5%D0%BD%D0%B8%D0%B5+%D0%B2%D0%B5%D1%89%D0%B5%D0 %B9+%D0%B2+%D0%BC%D0%BE%D1%81%D0%BA%D0%B2%D0%B5 | Маркетинговый источник визита. Отправка возможна только в запросе «Начался звонок» для входящих вызовов. |
| 16 | x-roistat | 444408 | Номер визита Roistat или маркер канала, если используется статический коллтрекинг. Отправка возможна только в запросе «Начался звонок» для входящих вызовов. |
| 17 | callee_from | 101 | Кто перевел звонок. |
| 18 | callee_to | 102 | На кого перевели звонок. |
| 19 | download_url | https://onlinepbx.ru/download/aFI0SVFqaVRDYTBueUpXQ1NtUkp3d0ZNRDZlSEsxSnc/rec.mp3 | Ссылка на скачивание звонка. Время жизни ссылки — 200 секунд. |
Формат запросов
Все HTTP-запросы отправляются в формате POST, тело запроса в формате: application/x-www-form-urlencoded.
Вы не нашли ответ на свой вопрос?
Обратитесь в нашу техническую поддержку: