Веб-хуки коллтрекинга

Назначение веб-хуков

Веб-хуки предназначены для получения информации о звонках на подменные номера коллтрекинга в режиме реального времени (real-time). Интеграция с коллтрекингом через веб-хуки может быть полезна для CRM-систем, систем сквозной аналитики, систем для управления контекстной рекламой и внутренних аналитических систем рекламных агентств. Веб-хуки бывают на начало и на конец звонка, в настройках Вы можете выбрать один из них или оба.

ВАЖНО: Веб-хук на начало звонка доступен, только если подключена услуга ВАТС API.

Принцип работы веб-хуков следующий: коллтрекинг в момент поступления/окончания звонка будет отправлять GET-запрос на указанный в настройках веб-хуков url и передавать рекламные метки и другую информацию о звонке в виде параметров. Соответственно, внешняя система сможет привязать звонок к конкретному контрагенту (если это CRM) или посетителю сайта и корректно отобразить данные о звонке, посетителе сайта и рекламных параметрах в собственных отчетах.

Подключение веб-хуков

1. В настройках коллтрекинга в Личном кабинете перейдите в раздел «API отчетов»:

2. В поле «WebHook Url» укажите:

• в какой момент должен срабатывать веб-хук - при поступлении или при окончании звонка. При выборе варианта «Начало звонка» убедитесь, что подключена услуга ВАТС API.
• пропишите url системы, на который необходимо передавать информацию. В параметрах url укажите, какие данные о звонке необходимо передавать.
  

Формат url адреса для веб-хука следующий:
https://example.com/some/path?phone={number}&duration={duration}
где:

• https или http – протокол;
• example.com/some/path - url-адрес веб-хука;
• phone={number}&duration={duration} - параметры, которые передаются на веб-хук.

Все параметры оформляются в виде: и разделяются символом ‘&’.

В приведенном примере после автоматической подстановки параметров будет вызываться следующий адрес: https://example.com/some/path?phone=79172221100&duration=75 .

3. Если вам необходимо отправлять данные на несколько адресов, добавьте еще один веб-хук и настройте его аналогично;
4. Все доступные наименования параметров коллтрекинга перечислены в таблице ниже. Вы можете использовать их все (или часть из них) в любой комбинации в параметрах url.

Название	Тип данных	Описание
callId	number	id звонка
dateStart	date	Время поступления звонка в формате ISO 8601: DD-MM-YYYYThh:mmZ
dateEnd	date	Время окончания звонка в формате ISO 8601: DD-MM-YYYYThh:mmZ
callType	number	Тип звонка: 1 - динамический, 2 - статический, 3 - дефолтный
callStatus	number	Статус завершения звонка как в ВАТС API, 11XX- звонок был принят, иначе - отклонён
number	number	Динамический номер, на который был принят звонок
callerNumber	number	Номер звонившего
duration	number	Продолжительность звонка в секундах. Считается только продолжительность разговора с оператором. Без учета времени ожидания в IVR и ожидания распределения звонка внутри группы операторов.
waitDuration	number	Время ожидания до соединения с оператором в секундах
isNew	boolean	Флаг уникального звонка
isQuality	boolean	Флаг качественного звонка
isDuplicate	boolean	Флаг того, что с этого номера звонили последние 3 месяца
uid	string	Уникальный идентификатор клиента MANGO OFFICE
gaCid	string	Идентификатор клиента Google Analytics
yaCid	string	Идентификатор клиента Яндекс Метрики
rsCid	string	Идентификатор сеанса (визита), используемый в системе "Roistat"
utmSource	string	Источник
utmMedium	string	Канал
utmCampaign	string	Кампания
utmContent	string	Содержание (объявления)
utmTerm	string	Ключевое слово
countryCode	string	Код ISO страны
regionCode	string	Код ISO региона
city	string	Название города
device	string	Тип устройства: desktop, tablet или mobile
ip	string	IP адрес пользователя
url	string	Адрес страницы сайта, с которой был совершён звонок
firstUrl	string	Адрес страницы входа пользователя на сайт
customParam	string	Дополнительные параметры, передаваемые в код виджета тем, кто разместил его на сайте. Ограничение - 4000 символов.