Пройдите простое обучение по настройке коллтрекинга.

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

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

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

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


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

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

Чтобы подключить вебхуки, на сайте «Личный кабинет» следует:
1) выберите ВАТС;
2) выберите коллтрекинг, подключенный к Вашей ВАТС;
3) выберите Настройки ;
4) выберите Остальные настройки ;
5) выберите, в какой момент должен срабатывать вебхук - при поступлении или при окончании звонка.

При выборе варианта «Начало звонка» убедитесь, что подключена услуга ВАТС API.


7) выберите параметры, которые нужно передавать в вебхуки;

Список параметров вебхуков на начало звонка и на конец звонка отличается. В таблице можно просмотреть перечень параметров вебхуки и их описание.


8) нажмите на кнопку "Создать вебхук":
Далее, в открывшейся форме Создание вебхуков укажите:
1) пропишите URL системы, на который необходимо передавать информацию. Формат URL адреса для вебхука следующий:
https://example.com/
где:
  • https или http – протокол;
  • example.com - URL-адрес вебхука;
2) выберите, какие парамеры (данные о звонке) необходимо передавать;
3) нажмите кнопку Сохранить.

Длина URL-адреса для вебхука не должна превышать 4000 символов.


Если Вам необходимо отправлять данные на несколько адресов, добавьте еще один вебхук и настройте его аналогично. После настройки вебхуки, нажмите Сохранить.
Если Вам необходимо отправлять данные на несколько адресов, добавьте еще один вебхук и настройте его аналогично. После настройки вебхуки, нажмите Сохранить

Параметры, передаваемые в вебхуки и их описание

Все доступные наименования параметров коллтрекинга перечислены в таблице ниже. Вы можете использовать их все (или часть из них) в любой комбинации в параметрах 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 адрес пользователя
URLl string Адрес страницы сайта, с которой был совершён звонок
firstUrl string Адрес страницы входа пользователя на сайт
customParam string Дополнительные параметры, передаваемые в код виджета тем, кто разместил его на сайте. Ограничение - 4000 символов.