Отправка информации из Calltouch с помощью webhook'ов
Описание технологии
Webhook — это исходящий HTTP-запрос, отправляемый в момент наступления определенного события. В запросе передается информация о лиде согласно выбранным настройкам.
C помощью вебхуков вы можете интегрировать Calltouch с внешними системами — для этого вам необходимо настроить отправку вебхуков в личном кабинете Calltouch. Добавить и настроить webhook'и можно в меню: Интеграции / Отправка данных во внешние системы / API и Webhooks.
В каком формате передаются webhook'и
Данные передаются в виде GET или POST запроса с набором выбранных параметров. Все данные, передаваемые в webhook'ах, проходят URL Encode и кодируются ASCII символами. При обработке данных на своей стороне, используйте, пожалуйста, URL Decoder для расшифровки значений параметров.
Адреса API/webhook серверов Calltouch
Вебхуки отправляются с наших серверов, расположенных на подсети 92.118.66.0/23. Эту подсеть необходимо добавить в список исключений файрволла на стороне вашего сервера.
Для тестирования вебхуков используйте сервис https://pipedream.com. Если вебхук приходит на тестовый сервер, но не приходит вам — значит причины необходимо искать на стороне вашего сервера.
Добавление нового webhook'а
Для добавления нового webhook'а, кликните на соответствующую кнопку "Добавить webhook":
И затем в открывшемся окне произведите настройки webhook'а , которые подробно описаны далее:
Настройка адреса обработчика webhook'а
Необходимо указать HTTP(S) адрес обработчика webhook'ов на вашем сервере, на который будут отправляться HTTP-запросы с нашей стороны автоматически при наступлении определенного события.
Домен в указываемом адресе обработчика не обязательно должен быть подключен к нашему сервису для отслеживания звонков, заявок с него — главное чтобы на нем присутствовало какое-либо приложение для регистрации webhook'ов.
Пример простого обработчика webhook'ов на PHP
Представленный пример парсит получаемый GET-запрос webhook'а, разбивая его по строкам и отправляет результат в письме с темой «Webhooks Test» на указанную Вами почту test@test.ru:
Скопировать скрипт:
<?php
$params = $_GET;
$mail_body = '';
foreach ($params as $k => $param){
if (!is_array($param))
$mail_body .= $k.' = '.$param."\n";
else
$mail_body .= $k.' = '.var_export($param, true)."\n";
}
mail("test@test.ru", "Webhooks Test", $mail_body);
?>
Вы можете протестировать этот пример, сохранив его в .php файл, расположенный на вашем сервере, и в настройках webhook'ах указать адрес к этому файлу в качестве обработчика. В зависимости от настроек, описываемых далее, на указанную вами почту в коде обработчика по факту начала и/или завершения звонка поступят webhook'и следующего содержания:
Метод отправки webhook'ов
По умолчанию webhook отправляется с помощью метода POST. Однако, вы можете изменить метод отправки на GET с помощью выпадающего меню:
В чем разница между методами отправки GET и POST?
Существует множество отличий между этими методами, из которых можно выделить три основных:
Принцип отправки | Используя метод GET, набор параметров отправляется в явном виде как часть URL. Используя метод POST, набор параметров отправляется в теле HTTP запроса. |
Размер запроса |
Длина GET-запроса может быть ограничена обработчиками на стороне клиента, а длина содержимого тела POST-запроса не ограничена, либо ограничение несоизмеримо больше, чем сам запрос. |
Безопасность |
Передача данных методом POST более безопасна, чем методом GET, так как секретные данные (например, API-токен ссылки на скачивание записи звонка в параметре reclink webhook'а) не отображаются напрямую в URL GET-запроса. Это наглядно демонстрируется в поле итогового HTTP-запроса, который и будет отправлен от нас на ваш сервер:
|
Модель атрибуции лидов в webhook'ах
Модель атрибуции — это правило определения источников для звонков и заявок. Источник обращения, переданный в webhook'е, может быть определен по одной из моделей атрибуции:
- Последний непрямой (по умолчанию) — источник обращения определится по последнему непрямому переходу на сайт. Если прямой переход на сайт будет единственным переходом перед совершением звонка или отправкой заявки, то источник определится как прямой переход. Источник "прямой переход" в статистики Calltouch обозначается как (direct) / (none).
- Последнее взаимодействие — источник обращения определится по последнему переходу на сайт перед совершением звонка или отправкой заявки.
Модель атрибуции выбирается из выпадающего списка:
Данные настройки моделей атрибуций для webhook'ов не повлияют на отображение статистики в отчетах личного кабинета Calltouch. Модель атрибуции для отчетов настраивается в разделе личного кабинета Calltouch: Настройки => Статистика.
В чем разница моделей атрибуции лидов в webhook'ах?
Предположим, вы настроили два webhook'а по событию начала звонка — первый с моделью атрибуции "Последнее взаимодействие", второй с моделью атрибуции "Последний непрямой". Затем посетитель днем с работы перешел на ваш сайт по платной рекламе yandex / cpc, ознакомился с контентом вашего сайта, добавил ваш сайт в закладки браузера и взял паузу на принятие решения. Вечером с того же устройства и браузера он вернулся на ваш сайт из закладок и совершил звонок. Переход из закладок браузера равносилен прямому переходу на сайт, в Calltouch он обозначается как (direct) / (none). На указанный вами адрес отправятся два webhook'а по одному и тому же звонку, но с разными моделями атрибуций, где источник звонка будет равен:
- в webhook'е с моделью атрибуции "Последнее взаимодействие" источник звонка = прямой переход (direct) / (none);
- в webhook'е с моделью атрибуции "Последний непрямой" источник звонка = платная реклама yandex / cpc.
Таким образом, источник одного и того же звонка определился по разному в каждом webhook'е, в соответствии с выбранной моделью атрибуции.
Метрики для отправок webhook'ов
По умолчанию отправка осуществляется по всем лидам. Однако, в зависимости от ваших потребностей, есть возможность ограничить HTTP-запросы только по определенным видам и типам лидов. Например, настроить отправку только для уникальных звонков и уникальных заявок:
Фильтр лидов по тегам
По умолчанию отправка осуществляется по всем лидам. Однако, в зависимости от ваших потребностей, есть возможность ограничить HTTP-запросы только по лидам, имеющим определенный тег. Например, настроить отправку только лидов с тегом "Отдел продаж":
Фильтр лидов по трафику
По умолчанию отправка осуществляется по всем лидам. Однако, в зависимости от ваших потребностей, есть возможность ограничить HTTP-запросы только по лидам, имеющим определенный источник. Например, настроить отправку только лидов, пришедших с платной рекламы:
Ограничив список лидов, вы рискуете пропустить важную информацию. Также обращаем внимание, что источник лида определяется согласно выбранной модели атрибуции в настройках вебхука.
Модель отправки
На выбор представлено 2 модели отправок:
- Упрощенная (по умолчанию) — модель, в рамках которой доступны 3 триггера для отправок: начало звонка, завершение звонка и создание заявки. Отличительной возможностью данной модели является опциональная отсрочка для событий завершения звонка и создания заявки. Установка отсрочек позволяет дождаться наиболее полной информации о лиде (например, автоматического тегирования Calltouch Предикт) и отправить ее на ваш сервер однократно. Максимальная величина задержки — 1440 минут, то есть 1 сутки. Список доступных событий:
- Начало звонка;
- Завершение звонка;
- Создание заявки.
- Событийная — модель, в рамках которой отправка HTTP-запросов происходит без каких-либо агрегаций сразу по наступлению события, на который подписан вебхук. При срабатывании триггера, на ваш сервер будет отправлен весь набор выбранных параметров согласно настройкам. Список доступных событий:
- Начало звонка;
- Завершение звонка;
- Создание заявки;
- Изменение статуса звонка;
- Изменение признака «Спам» у звонка;
- Расшифровка звонка в текст;
- Изменение тегов;
- Изменение комментариев;
- Изменение менеджера;
- Изменение рейтинга.
Как идентифицировать webhook'и одного и того же лида
В рамках одного лида может быть отправлено несколько HTTP-запросов. Идентифицировать webhook'и в рамках одного лида можно по его идентификатору:
- id — идентификатор звонка внутри Calltouch;
- requestId — идентификатор заявки внутри Calltouch.
Передаваемая информация в webhook'ах
На следующей табе "Передаваемая информация" необходимо выбрать параметры звонков и заявок, которые будут отправлены в webhook'е в вашу систему на указанный адрес обработчика:
По умолчанию передаются все параметры лидов. С помощью чекбоксов напротив названия каждого параметра вы сможете отключить или включить передачу какого-либо параметра. Кликнув на название параметра, раскроется его описание со списком возможных значений, информацией по типу обращений, для которых доступен параметр, и информацией об ограничениях по отправке параметра. Название параметра соответствует его макросу, однако вы можете изменить название параметра по своему усмотрению, кликнув в поле названия параметра и переименовав его.
Описание параметров:
Название |
Параметр |
Описание |
Тип обраще ния |
Ограниче ния |
Тип обращения |
leadtype |
Показывает, по какому типу обращения был отправлен webhook.
Возможные значения: |
Звонки Заявки Чаты |
Отсутствуют |
Фаза звонка |
callphase |
Текущее состояние звонка. |
Звонки | Отсутствуют |
ID звонка |
id |
Уникальный идентификатор звонка в Calltouch. |
Звонки | Отсутствуют |
Измененные поля |
changedFields |
Содержит названия измененных полей (в сравнении с предыдущей отправкой), перечисленных через запятую. Если отправка является первой по лиду в рамках настроенного вебхука, то в качестве значения будет передано null. | Звонки, Заявки | Отсутствуют |
ID заявки в Calltouch |
requestId |
Уникальный идентификатор заявки в Calltouch. | Заявки | Отсутствуют |
Внешний ID заявки | requestNumber | Уникальный идентификатор заявки, который был присвоен ей извне в параметре requestNumber API-метода создания заявок. | Заявки | Отсутствуют |
Название формы |
subject | Произвольное название формы на сайте, с которой отправляется заявка в Calltouch. | Заявки | Отсутствуют |
ID диалога | dialogId |
Все чаты с одним клиентом объединяются в один диалог. Данный параметр — уникальный идентификатор такого диалога в Calltouch. |
Чаты | Отсутствуют |
ID диалоговой сессии | dialogSessionId |
ID диалоговой сессии. Каждый завершенный чат с клиентом имеет отдельную сессию в рамках одного общего диалога. |
Чаты | Отсутствуют |
ID клиента |
ctCallerId |
Уникальный идентификатор клиента в Calltouch. |
Звонки | Отсутствуют |
ФИО клиента |
fio |
Произвольное имя пользователя, отправившего заявку. | Заявки | Отсутствуют |
ФИО клиента в чате | name | Имя клиента, заполнившего форму сбора контактов | Чаты | Отсутствуют |
Имя оператора | operatorName | Имя оператора, который ведет диалог | Чаты | Отсутствуют |
Номер клиента |
callerphone |
Телефонный номер клиента, с которого он выполняет звонок или оставляет заявку. Формат: 7XXXXXXXXXX |
Звонки, Заявки | Отсутствуют |
Контактный телефон клиента | phone | Телефон клиента, заполнившего форму сбора контактов | Чаты | Отсутствуют |
Email клиента |
Почта клиента, оставившего заявку. |
Заявки Чаты |
Отсутствуют | |
Отслеживаемый номер |
phonenumber |
Отслеживаемый номер, на который звонит клиент. Формат: 7XXXXXXXXXX |
Звонки | Отсутствуют |
Название сабпула |
subPoolName |
Название сабпула, с которым связан рекламный номер. |
Звонки | Отсутствуют |
Номер переадресации | redirectNumber |
Номер переадресации, на который направлялся звонок клиента. Если номер не удалось определить, а так же во всех webhook'ах по началу звонка, передается значение undefined. |
Звонки | Значение недоступно на момент начала звонка |
Длительность разговора |
duration |
Длительность телефонного разговора в секундах. |
Звонки | Значение недоступно на момент начала звонка |
Длительность ожидания |
waiting_time |
Длительность ожидания (гудки до поднятия трубки оператором) в секундах. |
Звонки | Значение недоступно на момент начала звонка |
Дата и время звонка в формате YYYY-MM-DD hh:mm:ss |
calltime |
Дата и время звонка начала звонка. |
Звонки | Отсутствуют |
Дата и время звонка в формате Unix Time Stamp |
timestamp |
Дата и время начала звонка в формате Unix Time Stamp в секундах. |
Звонки | Отсутствуют |
Дата и время заявки в формате YYYY-MM-DD hh:mm:ss | requestDate | Дата и время отправки заявки. | Заявки | Отсутствуют |
Статус звонка |
status |
Статус звонка. Возможные значения: |
Звонки | Значение недоступно на момент начала звонка |
Детализация статуса звонка |
statusDetails |
Детализация статуса звонка. |
Звонки | Значение недоступно на момент начала звонка |
Уникальный звонок или нет |
unique |
Уникальный звонок - это первый звонок клиента в рамках проекта с одного номера в рамках заданной глубины уникальности. |
Звонки | Отсутствуют |
Целевой звонок или нет |
targetcall |
Целевой звонок - это звонок, длительность которого уложилась в рамки целевого звонка, заданных в системных настройках ЛК, по умолчанию от 30 сек. |
Звонки | Значение недоступно на момент начала звонка |
Уникально-целевой звонок или нет |
uniqtargetcall |
Уникально-целевой звонок - это первый звонок от клиента, укладывающийся в рамки целевого звонка. Возможные значения: |
Звонки | Значение недоступно на момент начала звонка |
Обратный звонок или нет |
callback |
Обратный звонок — это звонок либо с виджета обратного звонка Calltouch, либо с формы сайта, подключенной к обратному звонку Calltouch. |
Звонки | Отсутствуют |
Уникальная заявка или нет | uniquerequest |
Уникальная заявка — это первая заявка с номера или почты клиента в рамках одного проекта и заданной глубины уникальности. Между звонками и заявками в настройках статистики так же может быть включена кросс-уникальность. Возможные значения:
true — уникальная заявка |
Заявки | Отсутствуют |
Целевая заявка или нет | targetrequest |
Целевая заявка — это заявка с реального номера или с реальной почты. Реальность номера проверяется по количеству указанных посетителем цифр в номере и их повтору, а реальность почты проверяется по наличию символа @ и доменного имени после него. Возможные значения:
target — целевая заявка |
Заявки | Отсутствуют |
Уникально-целевая заявка или нет | uniqtargetrequest |
Уникально-целевая заявка — это первая заявка клиента среди целевых. Возможные значения:
uniqtarget — уникально-целевая заявка |
Заявки | Отсутствуют |
Уникальное или повторное обращение в чат | unique |
Уникальный чат- это первый сеанс с пользователем. Возможные значения:
true — первое обращение в чат |
Чаты | Отсутствуют |
В рабочее или нерабочее время поступил звонок |
worktime |
Рабочее или нерабочее время, в которое пришел звонок, устанавливается в настройках прежней версии ЛК. Возможные значения: |
Звонки | Отсутствуют |
Звонок на статический или динамический номер |
pool |
Показывает, за каким типом пула закреплен номер, на который позвонил клиент. |
Звонки | Отсутствуют |
Рейтинг |
rating |
Рейтинг, присвоенный звонку или заявке. |
Звонки, Заявки | Значение недоступно на момент начала звонка |
Комментарии |
comment |
1. Комментарии ко звонку или заявке, оставленные звонкам через сайдбар журнала звонков во время разговора, или присвоенные заявкам в момент их отправки через API.
comment[0][party]= Если звонку или заявки не присвоен комментарий, параметр comment не передается вовсе. 2. Комментарий клиента, заполнившего форму сбора контактов в окне чата. |
Звонки, Заявки Чаты |
Значение недоступно на момент начала звонка |
Теги Calltouch Predict |
tags_auto_pr |
Теги, присвоенные звонку автоматически системой Calltouch Predict. |
Звонки | Значение недоступно на момент начала звонка |
Теги Calltouch Антифрод |
tags_auto_af |
Теги, присвоенные звонку автоматически системой Calltouch Антифрод. |
Звонки | Значение недоступно на момент начала звонка |
Теги по полу клиента |
tags_auto_gr |
Теги, присвоенные лиду автоматически в зависимости от пола клиента. |
Звонки, Заявки | Значение недоступно на момент начала звонка |
Теги по добавочным |
tags_auto_ct |
Теги, присвоенные звонку автоматически на основе введенных тоновых сигналов (добавочных) клиентом или оператором в ходе разговора. Для заявок это теги, проставленные автоматически с виджетов типа "Умная заявка". |
Звонки, Заявки | Значение недоступно на момент начала звонка |
Теги по номерам |
tags_auto_pn |
Теги, присвоенные лиду автоматически в зависимости от номера клиента или номера подмены. |
Звонки, Заявки | Отсутствуют |
Вручную проставленные теги |
tags_manual |
Теги, присвоенные лиду вручную пользователем в журнале звонков, заявок или лидов. |
Звонки, Заявки | Значение недоступно на момент начала звонка |
Теги, проставленные с помощью API | tags_api |
Теги, присвоенные лиду с помощью API. Если такие теги не были присвоены лиду, передается значение null. |
Звонки, Заявки | Отсутствуют |
Теги заявок | tags_request |
Теги, присвоенные заявке автоматически по имени/ID формы, с которой она была отправлена. |
Заявки | Отсутствуют |
Теги триггерных сценариев | tags_triggers |
Теги, присвоенные лиду в рамках отработки триггерных сценариев. |
Звонки, Заявки | Отсутствуют |
Теги из XLS импорта | tags_xls |
Теги, присвоенные лиду в рамках XLS импорта тегов. |
Звонки, Заявки | Отсутствуют |
Все теги | tags_all |
Все теги всех типов, присвоенные лиду |
Звонки, Заявки | Отсутствуют |
Модель атрибуции |
attribution |
Выбранная модель атрибуции в настройках webhook'а, согласно которой будет передаваться источник звонка или заявки. |
Звонки, Заявки | Отсутствуют |
Источник |
source |
Источник трафика перехода на сайт. |
Звонки, Заявки, Чаты |
Отсутствуют |
Канал |
medium |
Канал трафика перехода на сайт. |
Звонки, Заявки, Чаты | Отсутствуют |
Метка utm_source |
utm_source |
Значение utm-метки utm_source. |
Звонки, Заявки, Чаты |
Отсутствуют |
Метка utm_medium |
utm_medium |
Значение utm-метки utm_medium. |
Звонки, Заявки, Чаты |
Отсутствуют |
Метка utm_campaign |
utm_campaign |
Значение utm-метки utm_campaign. |
Звонки, Заявки, Чаты |
Отсутствуют |
Метка utm_content |
utm_content |
Значение utm-метки utm_content. |
Звонки, Заявки, Чаты |
Отсутствуют |
Метка utm_term |
utm_term |
Значение utm-метки utm_term. |
Звонки, Заявки, Чаты |
Отсутствуют |
Дополнительные отслеживаемые параметры |
add_url_params |
Дополнительный отслеживаемый произвольный параметр в URL, по которому перешли на сайт. |
Звонки, Заявки, Чаты | Отсутствуют |
Google Client ID |
gcid |
Идентификатор Google Client ID. Присутствует при настроенной интеграции с Google Analytics 4. Если интеграция не настроена, или настроена, но Google Client ID не удалось определить, параметр не передается вовсе. |
Звонки, Заявки, Чаты |
Отсутствуют |
Yandex Client ID |
yaClientId |
Идентификатор Yandex Client ID. Присутствует при настроенной интеграции с Яндекс.Метрика на отправку звонков. Если интеграция не настроена, или настроена, но Yandex Client ID не удалось определить, параметр не передается вовсе. |
Звонки, Заявки, Чаты |
Отсутствуют |
ID сессии Calltouch |
sessionId |
Идентификатор сессии Calltouch. |
Звонки, Заявки, Чаты |
Отсутствуют |
ID посетителя сайта |
ctClientId |
Идентификатор посетителя Calltouch. Он представляет из себя значение нашей куки _ct. Если в звонке или заявке значение отсутствует (у лида нет сессии, например, звонок на статический номер), то в значении будет null. |
Звонки, Заявки, Чаты |
Отсутствуют |
Глобальный ID посетителя сайта |
ctGlobalId |
Глобальный идентификатор посетителя Calltouch, общий для сайтов, на которых установлен скрипт Calltouch. Он представляет из себя значение сквозной куки _ct_client_global_id. Значение параметра формируется только при включении соответствующего сеттинга (требуется обратиться к вашему менеджеру). Если сеттинг не включен, или в лиде значение отсутствует (у лида нет сессии, например, звонок на статический номер), то в значении будет null. |
Звонки, Заявки, Чаты |
Отсутствуют |
Отслеживаемый сайт |
hostname |
Отслеживаемый домен или поддомен ресурса, на который был осуществлен переход (например: yoursite.ru). |
Звонки, Заявки, Чаты |
Отсутствуют |
Страница входа на сайт |
url |
URL, по которому попали на сайт (куда перешел посетитель). Фиксируется только страница входа в пределах сессии. Если URL не удалось определить, параметр передается с пустым значением. |
Звонки, Заявки, Чаты |
Отсутствуют |
Сторонние cookie | attrs |
Сторонние параметры, переданные заранее в статистику Calltouch (ссылку на статью из пункта 1 таска). Возможные значения: attrs: {"param1" "value1","param2""value2" |
Звонки, Заявки, Чаты |
Отсутствуют |
Страница |
callUrl |
Страница звонка. Фиксируется только если в настройках статистики включена одноименная опция. |
Звонки | Отсутствуют |
Страница |
requestUrl | Страница заявки | Заявки | Отсутствуют |
Идентификатор заявки |
callback_ request_id |
Уникальный идентификатор заявки, который присваивается после получения данных от пользователя на обратный звонок. | Звонки | Отсутствуют |
Флаг |
callback_ |
Флаг проставляется у звонка, на котором закончилась обработка заявки на обратный звонок после всех попыток повторных дозвонов. | Звонки | Отсутствуют |
Источник реферального перехода |
ref |
URL источника пользовательского перехода (откуда пришел посетитель). Присутствует только если был выполнен реферальный переход с какой-либо рекламной площадки, иначе передается пустое значение. |
Звонки, Заявки | Отсутствуют |
Город |
city |
Город, в котором находится клиент, совершивший звонок, оставил заявку или общается в чате. Определение города происходит по IP-адресу клиента, используется гео-база 2ip.ru. Если город не удалось определить, параметр передается с пустым значением. |
Звонки, Заявки, Чаты |
Отсутствуют |
Браузер |
browser |
Наименование и версия браузера, в котором был осуществлен переход. Определяется по User Agent клиента. Если браузер не удалось определить, параметр передается с пустым значением. |
Звонки, Заявки | Отсутствуют |
Операционная система |
os |
Наименование и версия операционной системы. Определяется по User Agent клиента. Если ОС не удалось определить, параметр передается с пустым значением. |
Звонки, Заявки | Отсутствуют |
Устройство |
device |
Информация об устройстве, с которого клиент перешел на сайт. Определяется по User Agent клиента. Если устройство не удалось определить, параметр передается с пустым значением. |
Звонки, Заявки | Отсутствуют |
IP-адрес |
ip |
IP-адрес клиента, совершившего звонок. |
Звонки, Заявки | Отсутствуют |
ID сеанса SIP |
sip_call_id |
Уникальный идентификатор сеанса связи с АТС Calltouch. Его значение отправляется на ваше оборудование в случае использования переадресации по SIP trunk. Может быть полезен при интеграции с вашей АТС. По умолчанию параметр отправляется в момент завершения звонка. Для получение данного параметра в момент начала звонка, отправьте заявку в тех. поддержку Calltouch info@calltouch.net. |
Звонки | Отсутствуют |
ID звонка с АТС |
callReference |
Технический идентификатор звонка внутри БД Calltouch. Может применяться для отладки каких-либо интеграций между Calltouch и внешними сервисами. | Звонки | Отсутствуют |
Запись разговора |
reclink |
Ссылка на запись звонка. Присутствует, если в настройках API не запрещено скачивание записей разговоров. Содержит ссылку со специальным JWT-токеном, по которой можно будет скачать только ту запись звонка, по которому был отправлен этот webhook. Таким образом, при каждой отправке webhook’а будет генерироваться уникальный JWT-токен. |
Звонки | Отсутствуют |
ID сделки | orderId | Идентификатор связанной с лидом сделки. | Звонки, Заявки | Значение недоступно на момент начала звонка |
ID сайта | siteId | Уникальный идентификатор вашего сайта внутри Calltouch, на котором был зафиксирован звонок. | Звонки, Заявки | Отсутствуют |
Название сайта | siteName | Название вашего сайта внутри Calltouch, на котором был зафиксирован звонок. | Звонки, Заявки | Отсутствуют |
User agent | userAgent | Строка с идентифицирующей информацией о пользователе, его устройстве и браузере | Звонки, Заявки | Отсутствуют |
Дата и время отправки вебхука в формате Unix Time Stamp |
sendingTimestamp | Дата и время отправки вебхука в формате Unix Time Stamp в секундах. | Звонки, Заявки | Отсутствуют |
Расшифровка звонка в текст | text |
Передается текстовая запись разговора. |
Звонки | Значение недоступно на момент начала звонка |
Менеджер | manager | Менеджер звонка или заявки. | Звонки, Заявки | Отсутствуют |
Спам или нет | spam |
Специальная отметка "Спам", проставляемая в сайдбаре журнала звонков. Возможные значения: |
Звонки | Значение недоступно на момент начала звонка |
Пользователь-ские поля виджетов Callback |
callback_ |
Значения пользовательских полей виджетов Callback.
callback_custom_fields[0][name]=поле 1&
|
Звонки, заявки |
Отсутствуют |
Пользовательские поля лидов |
custom_fields |
Пользовательские поля лидов, переданные по API. |
Звонки, заявки |
Отсутствуют |
Id лида Facebook |
callback_request_ |
Уникальный идентификатор клиента в Facebook Leads. Присутствует при настроенной интеграции с Facebook Leads . Если интеграция не настроена, или настроена, но ID не удалось определить, параметр не передается вовсе.
|
Звонки, Заявки |
Отсутствуют |
Название кампании из лида |
leadsCampaignName |
Название кампании лида из внешних источников
|
Звонки, Заявки |
Отсутствуют |
Тип события в чате | event_type |
Тип события chat_form_submitted_event — отправка формы chat_assing_operator_event — событие привязки оператора |
Чаты | Отсутствуют |
Имя пользователя в Телеграме | telegramUsername | Передается при условии обращения клиента через чат Телеграм | Чаты | Отсутствуют |
ID пользователя во Вконтакте | vkUserId | Передается при условии обращения клиента через чат Вконтакте | Чаты | Отсутствуют |
Выбранные параметры webhook'ов для вашего удобства будут отображены в поле "Итоговый HTTP-запрос" — итоговый запрос, который будет передан в вашу систему:
Активация webhook'а
После того, как все настройки выполнены — для активации webhook'ов необходимо сохранить настройки и вернувшись на страницу с их списком, активировать необходимый webhook с помощью соответствующего переключателя:
В случае, если приложение-обработчик в dашей системе не отвечает либо отвечает с ошибками, будет выведено уведомление, в котором будет предложено активировать вебхук, несмотря на то, что обработчик отвечает не 200 OK:
Редактирование существующего webhook'а
Для перенастройки существующего webhook'а достаточно навести на него курсором и кликнуть в появившемся меню на соответствующую кнопку "Редактировать". Для удобства вы можете так же создать копию существующего webhook'а со всеми его настройками. Созданная копия будет по умолчанию не активна:
Переотправка webhook'ов за определенный период
В случае, если вашим обработчиком не были получены данные (ответ сервера не 200 OK), либо обработчик работал некорректно (ответ сервера 200 OK, но данные использовались неверно), то вы можете вручную запустить процесс синхронизации данных, в результате чего будут переотправлены вебхуки по звонкам и заявкам за указанный период. Переотправка подразумевает повторную попытку отправки — это значит, что текущие настройки вебхука игнорируются. Переотправка осуществляется только по тем звонкам и заявкам, по которым была хотя бы одна попытка отправки. Выполнить переотправку за период, в котором вебхука не существовало или вебхук был выключен, невозможно. Максимально возможный выбранный период — 31 день.
По окончании пересбора вы увидите новое оповещение, которое будет содержать статус отправок:
- A/B тестирование (раздел «Подключение»)
- Email-трекинг (раздел «Подключение»)
- Отслеживание офлайн конверсии (раздел «Подключение»)
- Подключение к отслеживанию дополнительных доменов (раздел «Подключение»)
- Подмена номеров на AMP-страницах Google (раздел «Подключение»)