Наверх
Подписаться

Настройка вызова сторонних приложений

Содержание

 

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

Раздел "Интеграции => Webhooks" личного кабинета Calltouch позволяет настроить вызовы Ваших сторонних приложений посредством отправки уведомлений о звонках, зафиксированных в сервисе Calltouch, на Ваш сервер в виде GET-запросов.

C помощью данной технологии, Вы получаете возможность широкой настройки работы с собственными системами - для этого Вам необходимо лишь указать ссылку или несколько ссылок с адресом обработчика WebHook'ов на Вашем сервере, который будет вызываться с нашей стороны автоматически каждый раз по факту получения звонка на отслеживаемый номер Calltouch.

 

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

 

Настройка адреса обработчика WebHook'а

Для добавления нового WebHook'а, вначале необходимл заполнитьHTTP(S) адрес обработчика WebHook'ов на Вашем сервере, который будет вызываться с нашей стороны автоматически каждый раз по факту получения звонка на отслеживаемый номер Calltouch.

В первом примере на скриншоте выше это HTTP адрес приложения обработчика WebHook'ов:

http://site1.ru/webhook.php

Обратите внимание! Здесь site1.ru не обязательно должен быть подключен к нашему сервису, главное чтобы на нем присутствовало какое-либо приложение для регистрации WebHook'ов.

 

Настройка выходных параметров WebHook'а

Далее необходимо указать выходные параметры WebHook'а, которые будут отправлены нами в Вашу систему. Для этого необходимо кликнуть на "Параметры-макросы", после чего откроются заготовленные шаблоны:

webhooks_params.gif

В открывшемся списке необходимо отметить галочками параметры звонка, которые будут передаваться в WebHook'е. По умолчанию название параметра соответствует его макросу, однако Вы можете изменить название параметра по своему усмотрению. Рассмотрим каждый параметр более детально.

Параметр Макрос Описание (возможные значения)
callerphone {callerphone} Телефонный номер звонящего абонента
phonenumber {phonenumber} Номер Calltouch, на который звонит абонент
duration {duration} Длительность телефонного разговора
city {city} Город, с которого был осуществлен звонок
browser {browser} Наименование и версия браузера, в котором был осуществлен переход
id {id} Уникальный идентификатор звонка
waiting_time {waiting_time} Длительность ожидания
os {os} Наименование и версия операционной системы
status {status} Статус звонка
unique {unique} Уникальный звонок или нет (true / false)
targetcall {targetcall} Целевой звонок или нет (target / non-target)
uniqtargetcall {uniqtargetcall} Уникально-целевой или нет (uniqtarget / non-uniqtarget)
tags {tags} Список тегов звонка (перечисляются через запятую)
gcid {gcid} Google client id
ref {ref} URL пользовательского перехода (откуда пришёл)
hostname {hostname} Домен или поддомен ресурса, на который был осуществлен переход (например: ok.ru, vk.com, google.com)
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
source {source} Источник перехода
medium {medium} Тип источника перехода
calltime {calltime} Дата и время звонка в формате 2016-07-30 01:02:03
timestamp {timestamp} Дата и время звонка в формате unix timestamp
reclink {reclink} Ссылка на файл с записью звонка, для возможности скачивания записи необходимо быть заранее авторизованным в личном кабинете Calltouch
sessionId {sessionId} ИД сессии Calltouch
attribution {attribution}  Выбранная модель атрибуции звонков в системных настройках личного кабинета Calltouch

 

Выбранные параметры WebHook'ов для Вашего удобства будут отображены в поле "Результат" - итоговый GET запрос, который будет передан в Вашу систему по факту звонка:

http://site1.ru/webhook.php?callerphone={callerphone}&phonenumber={phonenumber}&duration={duration}&city={city}&browser={browser}&id={id}&waiting_time={waiting_time}&os={os}&status={status}&unique={unique}&targetcall={targetcall}&uniqtargetcall={uniqtargetcall}&tags={tags}&gcid={gcid}&url={url}&ref={ref}&hostname={hostname}&utm_source={utm_source}&utm_medium={utm_medium}&utm_campaign={utm_campaign}&utm_content={utm_content}&utm_term={utm_term}&source={source}&medium={medium}&calltime={calltime}&timestamp={timestamp}&reclink={reclink}&sessionId={sessionId}&attribution={attribution}

 

Активирование WebHook'а и возможные ошибки

После того, как указан пользовательский HTTP(S) адрес приложения для регистрации WebHook'ов и параметры, которые нужно передавать, для активации WebHook'а необходимо включить его соответствующим переключателем "Вкл/Выкл". При необходимости можно добавить или удалить дополнительные WebHook'и с помощью кнопок "+/-".

Активировав WebHook'и, не забудьте сохранить изменения одноименной кнопкой в конце раздела!

После активирования WebHook'ов для проверки соединения со стороны Calltouch в Вашу систему будет автоматически отправлен тестовый WebHook, где вместо реальных значений параметров, будут указаны значения calltouch_test_N, где N – порядковый номер переменной в запросе.

В случае, если приложение обработчик в Вашей системе не будет найдено, активировать WebHook не удасться, а Вам будет отображено сообщение с соответствующей ошибкой.

 

Дополнительная информация 

 

В какой момент передаются WebHook'и

Webhook'и передаются в Вашу систему из Calltouch по факту завершения звонка. Передача webhook'ов по факту начала разговора (до их завершения) на данный момент находится в разработке.

 

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

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

 

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

В целях безопасности Вы можете добавить IP-адреса наших API/Webhook серверов, с которых будут отправляться webhook'и, в список исключения брандмауэра Вашего сервера:

  • 95.163.114.93
  • 95.163.114.87
  • 95.163.114.147
  • 95.163.114.130
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 2 из 2
Еще есть вопросы? Отправить запрос

0 Комментарии

Войдите в службу, чтобы оставить комментарий.