Вебхуки (Webhook)
Webhook — это способ оповещения системы о каких-либо событиях. Gudok может оповещать сторонние системы о факте совершения звонка. Благодаря этому вы можете обогатить ваши системы, например, CRM, данными о звонках с рекламы.
После окончания звонка Гудок отправляет вебхук со всеми необходимыми данными на ваш сервер:
- id – ID звонка (уникален в рамках вашего аккаунта).
- project_id – ID проекта.
- project_title – название проекта.
- dst – Гудок-номер, на который поступил звонок.
- adv_channel_id – ID Гудок-номера.
- adv_channel_name – название Гудок-номера.
- src – номер звонящего.
- duration – продолжительность всего звонка.
- billsec – продолжительность разговора.
- callstatus – статус звонка, может быть:
- BUSY – номер занят,
- ANSWERED – отвечен,
- NO ANSWER – не отвечен.
- date – точные дата и время звонка по UTC.
- region – регион звонящего (определяется по номеру телефона).
- call_number – какой по счету звонок с этого номера (в рамках проекта).
- audio – ссылка на запись разговора (если опция подключена)
Вот пример запроса:
{ "id": 721, "project_id": 11, "project_title": "Мой первый проект", "dst": "73365841970", "adv_channel_id": "50", "adv_channel_name": "Название моего номера", "src": "74956409060", "duration": 23, "billsec": 13, "callstatus": "ANSWERED", "date": "2020-08-13 08:29:03 UTC", "region": "Москва", "call_number": 1, "audio": "https://in.gudok.tel/api/audio/XXX.mp3" }
Как настроить
- Зайдите в настройки проекта. Найдите раздел Уведомления.
- Включите вебхуки.
- Укажите ссылку, куда будет уходить вебхук.
- Выберите метод передачи GET или POST.
- Протестируйте отправку.
Это всё. Удачи!