Наверх

Отправка информации о звонках и заявках из Calltouch в любую систему с помощью webhook'ов

Содержание

 

 

Описание технологии

Webhook - это исходящий HTTP-запрос, отправляемый в момент наступления определенного события. В запросе передается информация о лиде согласно выбранным настройкам.  C помощью вебхуков мы можете интегрировать Calltouch с внешними системами - для этого вам необходимо настроить отправку вебхуков в личном кабинете Calltouch. Добавить и настроить webhook'и можно в меню "Интеграции", раздел "Отправка данных во внешние системы" - API и Webhooks:

mceclip1.png

 

В каком формате передаются webhook'и

Данные передаются в виде GET или POST запроса с набором выбранных параметров. Все данные, передаваемые в webhook'ах, проходят URL Encode и кодируются ASCII символами. При обработке данных на своей стороне, используйте, пожалуйста, URL Decoder для расшифровки значений параметров.

Адреса API/webhook серверов Calltouch

Вебхуки отправляются с наших серверов, расположенных на подсети 92.118.66.0/23. Эту подсеть необходимо добавить в список исключений файрволла на стороне вашего сервера.

Для тестирования вебхуков используйте сервис https://pipedream.com. Если вебхук приходит на тестовый сервер, но не приходит вам – значит причины необходимо искать на стороне вашего сервера.

   

Добавление нового webhook'а

Для добавления нового webhook'а, кликните на соответствующую кнопку "Добавить webhook":

mceclip2.png

И затем в открывшемся окне произведите настройки webhook'а, которые подробно описаны далее:

mceclip3.png

  Настройка адреса обработчика 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'и следующего содержания:

webhooks_test_new.jpg

advice_ver2.png Рассматриваемый обработчик, отправляющий только письма на почту, является просто примером. Возможности же вашего собственного обработчика webhook'ов ничем не ограничены.

Метод отправки webhook'ов

По умолчанию webhook отправляется с помощью метода POST. Однако, вы можете изменить метод отправки на GET с помощью выпадающего меню:

mceclip6.png

В чем разница между методами отправки GET и POST?

Существует множество отличий между этими методами, из которых можно выделить три основных:

Принцип отправки Используя метод GET, набор параметров отправляется в явном виде как часть URL. Используя метод POST, набор параметров отправляется в теле HTTP запроса.
Размер запроса

Длина GET-запроса может быть ограничена обработчиками на стороне клиента, а длина содержимого тела POST-запроса не ограничена, либо ограничение несоизмеримо больше, чем сам запрос.

Безопасность

Передача данных методом POST более безопасна, чем методом GET, так как секретные данные (например, API-токен ссылки на скачивание записи звонка в параметре reclink webhook'а) не отображаются напрямую в URL GET-запроса.

Это наглядно демонстрируется в поле итогового HTTP-запроса, который и будет отправлен от нас на ваш сервер:

mceclip4.png

Модель атрибуции лидов в webhook'ах

Модель атрибуции - эта правило определения источников для звонков и заявок. Источник обращения, переданный в webhook'е, может быть определен по одной из моделей атрибуции:

  • Последний непрямой (по умолчанию) - источник обращения определится по последнему непрямому переходу на сайт. Если прямой переход на сайт будет единственным переходом перед совершением звонка или отправкой заявки, то источник определится как прямой переход. Источник "прямой переход" в статистики Calltouch обозначается как (direct) / (none).
  • Последнее взаимодействие - источник обращения определится по последнему переходу на сайт перед совершением звонка или отправкой заявки.

Модель атрибуции выбирается из выпадающего списка:

mceclip5.png

 

advice_ver2.png Данные настройки моделей атрибуций для webhook'ов не повлияют на отображение статистики в отчетах личного кабинета Calltouch. Модель атрибуции для отчетов настраивается в разделе личного кабинета Calltouch: Настройки => Статистика.

В чем разница моделей атрибуции лидов в webhook'ах?

Предположим, вы настроили два webhook'а по событию начала звонка - первый с моделью атрибуции "Последнее взаимодействие", второй с моделью атрибуции "Последний непрямой". Затем посетитель днем с работы перешел на ваш сайт по платной рекламе yandex / cpc, ознакомился с контентом вашего сайта, добавил ваш сайт в закладки браузера и взял паузу на принятие решения. Вечером с того же устройства и браузера он вернулся на ваш сайт из закладок и совершил звонок. Переход из закладок браузера равносилен прямому переходу на сайт, в Calltouch он обозначается как (direct) / (none). На указанный вами адрес отправятся два webhook'а по одному и тому же звонку, но с разными моделями атрибуций, где источник звонка будет равен:

  • в webhook'е с моделью атрибуции "Последнее взаимодействие" источник звонка = прямой переход (direct) / (none);
  • в webhook'е с моделью атрибуции "Последний непрямой" источник звонка = платная реклама yandex / cpc.

Таким образом, источник одного и того же звонка определился по разному в каждом webhook'е, в соответствии с выбранной моделью атрибуции.

Метрики для отправок webhook'ов

По умолчанию отправка осуществляется по всем лидам. Однако, в зависимости от ваших потребностей, есть возможность ограничить HTTP-запросы только по определенным видам и типам лидов. Например, настроить отправку только для уникальных звонков и уникальных заявок: 

mceclip7.png

advice_ver2.png Обратите внимание, что ограничив список лидов, вы рискуете пропустить важную информацию.

Фильтр лидов по тегам

По умолчанию отправка осуществляется по всем лидам. Однако, в зависимости от ваших потребностей, есть возможность ограничить HTTP-запросы только по лидам, имеющим определенный тег. Например, настроить отправку только лидов с тегом "Отдел продаж": 

mceclip8.png

advice_ver2.png Обратите внимание, что ограничив список лидов, вы рискуете пропустить важную информацию. Также обращаем внимание, что ограничение не распространяется на отправку вебхуков по событию начала звонка.

Фильтр лидов по трафику

По умолчанию отправка осуществляется по всем лидам. Однако, в зависимости от ваших потребностей, есть возможность ограничить HTTP-запросы только по лидам, имеющим определенный источник. Например, настроить отправку только лидов, пришедших с платной рекламы: 

mceclip9.png

advice_ver2.png Обратите внимание, что ограничив список лидов, вы рискуете пропустить важную информацию. Также обращаем внимание, что источник лида определяется согласно выбранной модели атрибуции в настройках вебхука.

Модель отправки

На выбор представлено 2 модели отправок:

  • Упрощенная (по умолчанию) - модель, в рамках которой доступны 3 триггера для отправок: начало звонка, завершение звонка и создание заявки. Отличительной возможностью данной модели является опциональная отсрочка для событий завершения звонка и создания заявки. Установка отсрочек позволяет дождаться наиболее полной информации о лиде (например, автоматического тегирования Calltouch Предикт) и отправить ее на ваш сервер однократно. Максимальная величина задержки - 1440 минут, то есть 1 сутки. Список доступных событий:
    • Начало звонка;
    • Завершение звонка;
    • Создание заявки.
  • Событийная - модель, в рамках которой отправка HTTP-запросов происходит без каких-либо агрегаций сразу по наступлению события, на который подписан вебхук. При срабатывании триггера, на ваш сервер будет отправлен весь набор выбранных параметров согласно настройкам. Список доступных событий:
    • Начало звонка;
    • Завершение звонка;
    • Создание заявки;
    • Изменение статуса звонка;
    • Изменение признака «Спам» у звонка;
    • Расшифровка звонка в текст;
    • Изменение тегов;
    • Изменение комментариев;
    • Изменение менеджера;
    • Изменение рейтинга.

mceclip12.pngmceclip10.png

advice_ver2.png Обратите внимание, что изменение подписки на события будет распространяться только на лиды, поступившие после сохранения настроек. 

Как идентифицировать webhook'и одного и того же лида

В рамках одного лида может быть отправлено несколько HTTP-запросов. Идентифицировать webhook'и в рамках одного лида можно по его идентификатору:

  • id - идентификатор звонка внутри Calltouch;
  • requestId - идентификатор заявки внутри Calltouch.

Передаваемая информация в webhook'ах

На следующей табе "Передаваемая информация" необходимо выбрать параметры звонков и заявок, которые будут отправлены в webhook'е в вашу систему на указанный адрес обработчика:

mceclip13.png

По умолчанию передаются все параметры лидов. С помощью чекбоксов напротив названия каждого параметра вы сможете отключить или включить передачу какого-либо параметра. Кликнув на название параметра, раскроется его описание со списком возможных значений, информацией по типу обращений, для которых доступен параметр, и информацией об ограничениях по отправке параметра. Название параметра соответствует его макросу, однако вы можете изменить название параметра по своему усмотрению, кликнув в поле названия параметра и переименовав его.

Описание параметров:

Название

Параметр

Описание

Тип обращения Ограничения
Тип обращения

leadtype

Показывает, по какому типу обращения был отправлен webhook.

Возможные значения:
call – вебхук отправлен по звонку
request – вебхук отправлен по заявке

Звонки, Заявки Отсутствуют
Фаза звонка

callphase

Текущее состояние звонка.
Возможные значения:
callconnected — начала звонка
calldisconnected — завершенный звонок

Звонки Отсутствуют
ID звонка

id

Уникальный идентификатор звонка в Calltouch.

Звонки Отсутствуют
Измененные поля

changedFields

Содержит названия измененных полей (в сравнении с предыдущей отправкой), перечисленных через запятую. Если отправка является первой по лиду в рамках настроенного вебхука, то в качестве значения будет передано null. Звонки, Заявки Отсутствуют
ID заявки в Calltouch

requestId

Уникальный идентификатор заявки в Calltouch. Заявки Отсутствуют
Внешний ID заявки requestNumber Уникальный идентификатор заявки, который был присвоен ей извне в параметре requestNumber API-метода создания заявок. Заявки Отсутствуют
Название формы subject Произвольное название формы на сайте, с которой отправляется заявка в Calltouch. Заявки Отсутствуют
ID клиента

ctCallerId

Уникальный идентификатор клиента в Calltouch.
Определяется по номеру телефона клиента. Его удобно использовать, когда нужно идентифицировать клиента без использования его персональных данных (номер телефона).

Звонки Отсутствуют
ФИО клиента

fio

Произвольное имя пользователя, отправившего заявку. Заявки Отсутствуют
Номер клиента

callerphone

Телефонный номер клиента, с которого он выполняет звонок или оставляет заявку.

Формат: 7XXXXXXXXXX

Звонки, Заявки Отсутствуют
Email клиента email

Почта клиента, оставившего заявку.
Формат: user@server.com

Заявки Отсутствуют
Отслеживаемый номер

phonenumber

Отслеживаемый номер, на который звонит клиент.

Формат: 7XXXXXXXXXX

Звонки Отсутствуют
Номер переадресации 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

Статус звонка. Возможные значения:
successful - удачный звонок
unsuccessful - неудачный звонок

Звонки Значение недоступно на момент начала звонка
Уникальный звонок или нет

unique

Уникальный звонок - это первый звонок клиента в рамках проекта с одного номера в рамках заданной глубины уникальности.
Возможные значения:
true - уникальный звонок
false - повторный звонок

Звонки Отсутствуют
Целевой звонок или нет

targetcall

Целевой звонок - это звонок, длительность которого уложилась в рамки целевого звонка, заданных в системных настройках ЛК, по умолчанию от 30 сек.
Возможные значения:
target - целевой звонок
non-target - нецелевой звонок

Звонки Значение недоступно на момент начала звонка
Уникально-целевой звонок или нет

uniqtargetcall

Уникально-целевой звонок - это первый звонок от клиента, укладывающийся в рамки целевого звонка. Возможные значения:
uniqtarget - уникально-целевой звонок
non-uniqtarget - не уникально-целевой звонок

Звонки Значение недоступно на момент начала звонка
Обратный звонок или нет

callback

Обратный звонок - это звонок либо с виджета обратного звонка Calltouch, либо с формы сайта, подключенной к обратному звонку Calltouch.
Возможные значения:
callback - обратный звонок
non-callback - прямой звонок на отслеживаемый номер

Звонки Отсутствуют
Уникальная заявка или нет uniquerequest

Уникальная заявка – это первая заявка с номера или почты клиента в рамках одного проекта и заданной глубины уникальности. Между звонками и заявками в настройках статистики так же может быть включена кросс-уникальность.

Возможные значения:

true – уникальная заявка
false – повторная заявка

Заявки Отсутствуют
Целевая заявка или нет targetrequest

Целевая заявка – это заявка с реального номера или с реальной почты. Реальность номера проверяется по количеству указанных посетителем цифр в номере и их повтору, а реальность почты проверяется по наличию символа @ и доменного имени после него.

Возможные значения:

target – целевая заявка
non-target – нецелевая заявка

Заявки Отсутствуют
Уникально-целевая заявка или нет uniqtargetrequest

Уникально-целевая заявка – это первая заявка клиента среди целевых.

Возможные значения:

uniqtarget – уникально-целевая заявка
non-uniqtarget – не уникально-целевая заявка

Заявки Отсутствуют
В рабочее или нерабочее время поступил звонок

worktime

Рабочее или нерабочее время, в которое пришел звонок, устанавливается в настройках прежней версии ЛК. Возможные значения:
worktime - рабочее время
non-worktime - нерабочее время

Звонки Отсутствуют
Звонок на статический или динамический номер

pool

Показывает, за каким типом пула закреплен номер, на который позвонил клиент.
Возможные значения:
dynamic - звонок на номер из динамического пула
staticOffline - звонок на статический оффлайн номер
staticOnline - звонок на статический онлайн номер
null - присваивается звонкам с формы обратного звонка.

Звонки Отсутствуют
Рейтинг

rating

Рейтинг, присвоенный звонку или заявке.
Возможные значения:
0 - рейтинг не присвоен
1/2/3/4/5 - звонку или заявке присвоен рейтинг от 1 до 5 соответственно.

Звонки, Заявки Значение недоступно на момент начала звонка
Комментарии 

comment

Комментарии ко звонку или заявке, оставленные звонкам через сайдбар журнала звонков во время разговора, или присвоенные заявкам в момент их отправки через API.
Передаются массивом по шаблону:
comment[0][party]=user1&
comment[0][comment]=comment_by_user1&
comment[1][party]=user2&
comment[1][comment]=comment_by_user2&
Если звонку или заявки не присвоен комментарий, параметр comment не передается вовсе.

Звонки, Заявки Значение недоступно на момент начала звонка
Теги Calltouch Predict

tags_auto_pr

Теги, присвоенные звонку автоматически системой Calltouch Predict.
Если такие теги не были присвоены звонку, передается значение null.

Звонки Значение недоступно на момент начала звонка
Теги Calltouch Антифрод

tags_auto_af

Теги, присвоенные звонку автоматически системой Calltouch Антифрод.
Если такие теги не были присвоены звонку, передается значение null.

Звонки Значение недоступно на момент начала звонка
Теги по полу клиента

tags_auto_gr

Теги, присвоенные лиду автоматически в зависимости от пола клиента.
Если такие теги не были присвоены лиду, передается значение null.

Звонки, Заявки Значение недоступно на момент начала звонка
Теги по добавочным

tags_auto_ct

Теги, присвоенные звонку автоматически на основе введенных тоновых сигналов (добавочных) клиентом или оператором в ходе разговора. Для заявок это теги, проставленные автоматически с виджетов типа "Умная заявка".
Если такие теги не были присвоены звонку или заявке, передается значение null.

Звонки, Заявки Значение недоступно на момент начала звонка
Теги по номерам

tags_auto_pn

Теги, присвоенные лиду автоматически в зависимости от номера клиента или номера подмены.
Если такие теги не были присвоены лиду, передается значение null.

Звонки, Заявки Отсутствуют
Вручную проставленные теги

tags_manual

Теги, присвоенные лиду вручную пользователем в журнале звонков, заявок или лидов.
Если такие теги не были присвоены лиду, передается значение null.

Звонки, Заявки Значение недоступно на момент начала звонка
Теги, проставленные с помощью API tags_api

Теги, присвоенные лиду с помощью API. Если такие теги не были присвоены лиду, передается значение null.

Звонки, Заявки Отсутствуют
Теги заявок tags_request

Теги, присвоенные заявке автоматически по имени/ID формы, с которой она была отправлена.
Если такие теги не были присвоены заявке, передается значение null.

Заявки Отсутствуют
Модель атрибуции

attribution

Выбранная модель атрибуции в настройках webhook'а, согласно которой будет передаваться источник звонка или заявки.
Возможные значение:
1 - выбрана модель атрибуции “Последний непрямой” (по умолчанию)
0 - выбрана модель атрибуции “Последнее взаимодействие”

Звонки, Заявки Отсутствуют
Источник

source

Источник трафика перехода на сайт.
Либо название источника в настройках статического пула, если номер закреплен за ним и переход на сайт не предусмотрен.

Звонки, Заявки Отсутствуют
Канал

medium

Канал трафика перехода на сайт.
Либо название канала в настройках статического пула, если номер закреплен за ним и переход на сайт не предусмотрен. Если значение отсутствует, передается значение <не указано>.

Звонки, Заявки Отсутствуют
Метка utm_source

utm_source

Значение utm-метки utm_source.
Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_source отсутствовала или была пуста, то передается значение <не заполнено>.

Звонки, Заявки Отсутствуют
Метка utm_medium

utm_medium

Значение utm-метки utm_medium.
Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_medium отсутствовала или была пуста, то передается значение <не заполнено>.

Звонки, Заявки Отсутствуют
Метка utm_campaign

utm_campaign

Значение utm-метки utm_campaign.
Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_campaign отсутствовала или была пуста, то передается значение <не заполнено>.

Звонки, Заявки Отсутствуют
Метка utm_content

utm_content

Значение utm-метки utm_content.
Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_content отсутствовала или была пуста, то передается значение <не заполнено>.

Звонки, Заявки Отсутствуют
Метка utm_term

utm_term

Значение utm-метки utm_term.
Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_term отсутствовала или была пуста, то передается значение <не заполнено>.

Звонки, Заявки Отсутствуют
Дополнительные отслеживаемые параметры

add_url_params

Дополнительный отслеживаемый произвольный параметр в URL, по которому перешли на сайт.
Дополнительные отслеживаемые параметры добавляются в настройках прежней версии ЛК. Например, если клиент перешел на сайт по URL:
https://site.ru?utm_source=yandex&utm_medium=cpc&abtest=a
где параметр abtest был ранее добавлен к отслеживанию в url, то webhook'ах будет передан массив:
add_url_params[0][name]=abtest&
add_url_params[0][value]=a&
Если дополнительных параметров не было в URL перехода, параметр add_url_params не передается вовсе.

Звонки, Заявки Отсутствуют
Google Client ID

gcid

Идентификатор Google Client ID. Присутствует при настроенной интеграции с Google Analytics. Если интеграция не настроена, или настроена, но Google Client ID не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
Yandex Client ID

yaClientId

Идентификатор Yandex Client ID. Присутствует при настроенной интеграции с Яндекс.Метрика на отправку звонков. Если интеграция не настроена, или настроена, но Yandex Client ID не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
ID сессии Calltouch

sessionId

Идентификатор сессии Calltouch.

Звонки, Заявки Отсутствуют
Отслеживаемый сайт

hostname

Отслеживаемый домен или поддомен ресурса, на который был осуществлен переход (например: yoursite.ru).

Звонки, Заявки Отсутствуют
Страница входа на сайт

url

URL, по которому попали на сайт (куда перешел посетитель). Фиксируется только страница входа в пределах сессии. Если URL не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
Сторонние cookie attrs

Сторонние параметры, переданные заранее в статистику Calltouch (ссылку на статью из пункта 1 таска). Возможные значения:

attrs: {"param1" "value1","param2""value2"
Звонки, Заявки Отсутствуют
Страница звонка callUrl

Страница звонка. Фиксируется только если в настройках статистики включена одноименная опция.

Звонки Отсутствуют
Страница заявки requestUrl Страница заявки Заявки Отсутствуют
Идентификатор заявки на обратный звонок callback_request_id Уникальный идентификатор заявки, который присваивается после получения данных от пользователя на обратный звонок. Звонки Отсутствуют
Флаг завершения цепочки вызовов callback_final_attempt  Флаг проставляется у звонка, на котором закончилась обработка заявки на обратный звонок после всех попыток повторных дозвонов. Звонки Отсутствуют
Источник реферального перехода

ref

URL источника пользовательского перехода (откуда пришел посетитель). Присутствует только если был выполнен реферальный переход с какой-либо рекламной площадки, иначе передается пустое значение.

Звонки, Заявки Отсутствуют
Город

city

Город, в котором находится клиент, совершивший звонок. Определение города происходит по IP-адресу клиента, используется гео-база 2ip.ru. Если город не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
Браузер

browser

Наименование и версия браузера, в котором был осуществлен переход. Определяется по User Agent клиента. Если браузер не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
Операционная система

os

Наименование и версия операционной системы. Определяется по User Agent клиента. Если ОС не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
Устройство

device

Информация об устройстве, с которого клиент перешел на сайт. Определяется по User Agent клиента. Если устройство не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
IP-адрес

ip

IP-адрес клиента, совершившего звонок.
Если IP не удалось определить, параметр передается с пустым значением.

Звонки, Заявки Отсутствуют
ID сеанса SIP

sip_call_id

Уникальный идентификатор сеанса связи с АТС Calltouch. Его значение отправляется на ваше оборудование в случае использования переадресации по SIP trunk. Может быть полезен при интеграции с вашей АТС.

По умолчанию параметр отправляется в момент завершения звонка. Для получение данного параметра в момент начала звонка, отправьте заявку в тех. поддержку Calltouch info@calltouch.net

Звонки Отсутствуют
ID звонка с АТС callReferenceNumber Технический идентификатор звонка внутри БД 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

Передается текстовая запись разговора.

Если у звонка имеется текстовая запись разговора, то фразы передаются массивом по шаблону:

text[0][channel]=operator&
text[0][phrase]=phrase_by_operator&
text[1][channel]=client&
text[1][phrase]=phrase_by_client&

Если у звонка нет текстовой записи разговора, то в качестве значения будет передано null.

Звонки Значение недоступно на момент начала звонка
Менеджер manager Менеджер звонка или заявки. Звонки, Заявки Отсутствуют
Спам или нет spam

Специальная отметка "Спам", проставляемая в сайдбаре журнала звонков. Возможные значения:
true - звонок помечен как "Спам"
false - звонок без отметки "Спам"

Звонки Значение недоступно на момент начала звонка

 

Выбранные параметры webhook'ов для вашего удобства будут отображены в поле "Итоговый HTTP-запрос" - итоговый запрос, который будет передан в вашу систему:

mceclip1.png

Активирование webhook'а

После того, как все настройки выполнены - для активации webhook'ов необходимо сохранить настройки и вернувшись на страницу с их списком, активировать необходимый webhook с помощью соответствующего переключателя:

mceclip2.png

В случае, если приложение-обработчик в dашей системе не отвечает либо отвечает с ошибками, будет выведено уведомление, в котором будет предложено активировать вебхук, несмотря на то, что обработчик отвечает не 200 OK:

mceclip3.png

 

Редактирование существующего webhook'а

Для перенастройки существующего webhook'а достаточно навести на него курсором и кликнуть в появившемся меню на соответствующую кнопку "Редактировать". Для удобства вы можете так же создать копию существующего webhook'а со всеми его настройками. Созданная копия будет по умолчанию не активна:

mceclip4.png

 

Переотправка webhook'ов за определенный период

В случае, если вашим обработчиком не были получены данные (ответ сервера не 200 OK), либо обработчик работал некорректно (ответ сервера 200 OK, но данные использовались неверно), то вы можете вручную запустить процесс синхронизации данных, в результате чего будут переотправлены вебхуки по звонкам и заявкам за указанный период. Переотправка подразумевает повторную попытку отправки – это значит, что текущие настройки вебхука игнорируются. Переотправка осуществляется только по тем звонкам и заявкам, по которым была хотя бы одна попытка отправки. Выполнить переотправку за период, в котором вебхука не существовало или вебхук был выключен, невозможно. Максимально возможный выбранный период - 31 день. 

mceclip5.png

По окончании пересбора вы увидите новое оповещение, которое будет содержать статус отправок:

mceclip6.png