Page tree
Skip to end of metadata
Go to start of metadata

Веб-хук (webhook) — это отправка запросов по событиям из onlinePBX. Запросы уведомляют сторонние сервисы об изменениях в АТС. Позволяют отслеживать звонки, их состояние и другие события onlinePBX — информация отправляется на указанный URL. Веб-хуки могут использоваться для интеграции.

Подключение

Для подключения веб-хуков необходимо указать адрес URL, куда будут отправляться POST-запросы. Для этого в панели управления перейдите в Интеграция > Webhooks, и нажмите «Добавить».

Появится строка с настройкой. Введите адрес URL, а также выберите, какие именно события хотите получать. На выбор есть шесть вариантов. Не забудьте сохранить изменения.

 Подробное описание уведомлений:
  • Начало звонка (событие отправляется сразу после начала звонка);
  • Дозвон до пользователя (событие отправляется при начале дозвона до пользователя);
  • Ответили (событие отправляется при успешном начале разговора);
  • Завершили (событие отправляется сразу после завершения разговора);
  • Пропущенный (событие отправляется при окончании дозвона);
  • Перевод звонка (событие отправляется, после того как второй сотрудник принял переведённый звонок).


(warning) Веб-хуки будут отправляться только если на указанном URL (https://) действительный сертификат безопасности (SSL-сертификат).

(warning) В случае получения ошибки или отсутствие ответа при передаче POST-запросов, наш сервис отправляет запрос повторно еще 2 раза с интервалом в 5 секунд.


Статус

Для тестирования веб-хуков мы добавили в выпадающее меню функцию «Тест». По клику будет совершаться отправка тестового веб-хука. При получении ошибки, её номер или описание покажется в подсказке. В Истории указывается, что был проведен тест.

Три статуса подключения: 

  1. Серый «Не подключен» — показывается до отправки первого события;
  2. Зелёный «Подключен» — после успешного прохождения теста;
  3. Красный «Отключен» — при получении ошибки в ходе теста.

История

Сервис хранит историю отправки веб-хуков и ответы от сервера. Можно посмотреть в правой части страницы.

Если произошла ошибка во время передачи, рядом с полем «Тип» появится значок ошибки. При наведении покажется статус, полученный от сервера, куда был отправлен веб-хук.

(warning) История отображается не моментально. Обновите страницу, чтобы увидеть актуальную историю.



Примеры запросов

Начался звонок

{
"domain":"onlinepbx.ru",
"event":"call_start",
"direction":"outbound",
"uuid":"d02d3dd1-36f9-41g8-9055-3139369h6h90",
"caller":"505",
"from_domain":"onlinepbx.ru",
"to_domain":"",
"gateway":"74991111282",
"date":"1528886454"

"x-roustat-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"
}

(warning) Если в аккаунте onlinePBX зарегистрирован внешний номер от Roistat, — не будет передаваться параметр x-roistat.

(warning) При использовании схемы Оператор > Roistat > Оператор > onlinePBX, не будут передаваться параметры x-roustat-marker и x-roistat.

Ответили на звонок

{
"domain":"onlinepbx.ru",
"event":"call_answered",
"direction":"outbound",
"uuid":"2c033c12-7310-4v4v-9b42-8bb207b17322",
"caller":"505",
"callee":"79111117799",
"to_domain":"",
"gateway":"74991111112",
"date":"1528888621"

}

Завершился звонок

{
"domain":"onlinepbx.ru",
"event":"call_end",
"direction":"outbound",
"uuid":"6q5qq87q-0w32-4e23-8570-3r6rr6rrrr2r",
"caller":"145",
"callee":"79502222919",
"from_domain":"onlinepbx.ru",
"to_domain":"onlinepbx.ru",
"gateway":"74991111282",
"date":"1528884937",
"call_duration":"149",
"dialog_duration":"135",
"hangup_cause":"NORMAL_CLEARING",
"hangup_by":"caller"

}

Пропущенный звонок

{

"domain":"onlinepbx.ru",
"event":"call_missed",
"direction":"inbound",
"uuid":"5329a333-ss32-4dd9-ff0f-gh84g32h5g22",
"caller":"79221111123",
"from_domain":"onlinepbx.ru",
"to_domain":"onlinepbx.ru",
"gateway":"73431111137",
"date":"1529406933"

}

Дозвон до пользователя

{
"domain":"onlinepbx.ru",
"event":"call_user_start",
"direction":"outbound",
"uuid":"d02d3dd1-36f9-41g8-9055-3139369h6h90",
"caller":"505",
"callee":"79111117960",
"from_domain":"onlinepbx.ru",
"to_domain":"",
"gateway":"74991111282",
"date":"1528886454"

}



Перевод звонка

{
"domain":"onlinepbx.ru",
"event":"call_transfer_answered",
"direction":"inbound",
"uuid":"b47fab84-5874-4de3-9c3b-8f1c744c8d8f",
"caller":"101",
"callee_from":"101",
"callee_to":"102",
"date":"1585229375737"
}

(warning) Параметры x-roistat-marker и x-roistat отправляются только при рабочей интеграции с сервисом Roistat.

Список переменных и описание

ПеременнаяПример значения переменнойОписание переменной
1domainexample.onpbx.ruДомен, в котором состоялось событие.
2eventcall_end / call_answered / call_start / call_user_startТип события.
3directioninbound / outboundТип звонка (входящий/исходящий).
4uuid5921a027-c22f-4351-b495-30a49f00e4e1Уникальный идентификатор сессии.
5caller+79510057057 / 510@onlinepbx.ruЗвонящий.
6callee79827347182 / 102Кому звонили.
7from_domainexamplefrom.onpbx.ruДомен звонящего.
8to_domainexampleto.onpbx.ruДомен того, кому звонили.
9gateway74922296721Транк, на/с которого позвонили.
10date1527578Дата в формате UNIX.
11call_duration159Общая длительность звонка (сек.).
12dialog_duration145Длительность разговора (сек.).
13hangup_causeNORMAL_CLEARINGПричина завершения звонка.
14hangup_bycaller / calleeКто инициировал завершение вызова.
15x-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

Маркетинговый источник визита. Отправка возможна только в запросе «Начался звонок».
16x-roistat444408Номер визита Roistat или маркер канала, если используется статический коллтрекинг. Отправка возможна только в запросе «Начался звонок».
17callee_from101Кто перевел звонок.
18callee_to102На кого перевели звонок.

Формат запросов

Все HTTP-запросы отправляются в формате POST, тело запроса в формате: application/x-www-form-urlencoded.


Вы не нашли ответ на свой вопрос?

Обратитесь в нашу техническую поддержку:

+7 (495) 669-67-21
+7 (343) 302-01-37
+7 (343) 646-51-40

Почта — support@onlinepbx.ru

Write a comment…