Webhook – механизм оповещений системы и/или сторонних систем, о событиях телефонии или Виртуальной АТС Ringostat в определённый момент.
При возникновении события, созданный ранее в ЛК, webhook-обработчик отправляет HTTP-запрос с набором параметров на URL, который был указан для этого Webhook.
Если URL, на который отправляется Webhook, недоступен (отвечает не HTTP 200 OK), попыток повторной отправки Webhook на этот URL до получения ожидаемого 200 ОК не будет. Webhook будет отмечен "с ошибкой", его статус отправки и ошибку можно будет просмотреть на странице Проверка ошибок Webhooks
- Событие – " Входящий звонок "
- перед звонком;
- после звонка;
- после меню оценки звонка;
- в момент поднятия трубки
- шаг переадресации
- Событие – " Исходящий звонок "
- перед звонком;
- после звонка;
Создание webhook запроса
В личном кабинете перейдите в раздел
Интеграция, затем на страницу Webhooks. Страница содержит таблицу включённых и настроенных интеграций проекта. По умолчанию, добавлен и настроен webhook для Google Analytics.
Чтобы создать новый webhook-запрос нажмите Добавить новую интеграцию
После клика на кнопку будет показано pop-up окно настроек для обработчика.
- Имя – название webhook или интеграции;
- URL – адрес обработчика, на который будет отправлен запрос. Стандартные порты: 80 для HTTP и 443 для HTTPS.
Для установки Webhook на URL с указанным портом можно передавать URL в виде: http://11.111.111.11:80 - Момент отправки данных – момент события, когда будет отправлен запрос
- Метод отправки данных:
- GET – запрос с передачей параметров в адресной строке(URL-адресе запроса);
- POST – запрос с передачей параметров в теле(body) запроса;
- PUT – запрос для изменения экземпляра с указанным ID;
- DELETE – запрос с передачей параметров для удаления экземпляра с указанным ID;
- Формат отправки данных – формат переданных данных на обработчик запроса.
- http – отправка параметров в адресной строке(URL-адресе запроса);
- json – отправка параметров в формате объекта(набор пар ключ/значение) в теле запроса;
- xml – отправка параметров в формате xml;
- Формат даты – формат в котором будет отправлена дата
- default – (2015-06-12 15:52:01)
- DATE_COOKIE – (Friday, 12-Jun-2015 15:52:01 UTC)
- DATE_ISO8601 – (2015-06-12T15:52:01+0200)
- DATE_RFC822 – (Fri, 12 Jun 15 15:52:01 +0200)
- unixtime – (1434120721)
После настройки, нажмите " Сохранить" для создания запроса и можно приступить к добавлению параметров, которые будут переданы запросом в выбранный момент события.
Добавление параметров в Webhook-запрос
Чтобы добавить к webhook-запросу параметры - выберите " Настроить Webhook"(пиктограмма шестерёнки).
Далее, нужно выбрать из списка доступные для передачи параметры в выбранный момент и указать их имя:
На этом создание webhook-запроса завершено.
Проверка ошибок Webhooks
Страница со списком интеграций содержит кнопку, по клику на которую будет выполнен переход на страницу с webhook-запросами, которые "выпали" в ошибку.
Возле каждой записи есть 2 кнопки: Проверен и Отправить.
Кнопка Проверен – позволяет удалить запись webhook'а с ошибкой из списка.
Кнопка
Отправить – позволяет выполнить повторную попытку передачи webhook'а, с ошибкой.
Если передача успешна – он удаляется из списка.
Все webhook-запросы могут быть отправлены с разных серверов Ringostat. В случае использования firewall или списка разрешённых подключений, нужно добавить пул IP-адресов серверов Ringostat в список исключений.
138.201.203.93
176.9.24.184
185.60.135.92
88.204.205.58
209.126.106.57
185.67.1.90
Описание событий, моментов отправки данных и доступных параметров
- Событие – "Входящий звонок"
- Событие – "Исходящий звонок"
Событие " Входящий звонок" включает 5 моментов для отправки оповещений. Каждый момент содержит список параметров доступных для передачи.
Передавая в CRM-систему информацию о принятых звонках, их можно сопоставить со сделками которые завели менеджеры. Таким образом, вы получаете дополнительный инструмент контроля отдела продаж и автоматизации работы в crm-системе.
Давайте детально рассмотрим моменты отправки оповещений и доступные параметры, для каждого момента.
Звонки Callback относятся к событию Входящий звонок, поэтому для отправки параметров нужно выбирать моменты, которые относятся к этому событию.
Отделить звонки вы можете ориентируясь на значение параметра
Тип подмены:
- dynamic
- static
- callback
Передача параметров пользователя
Для события Входящий звонок характерна передача параметров пользователя. Это может быть переменная в глобальной области видимости или статический параметр для идентификации приложения, переданный в URL-запроса.
Передача параметра custom
Чтобы передать параметр custom, нужно настроить отслеживаемые сущности на странице настроек скрипта подмены номеров.
Обратите внимание! В параметре custom можно передать только результат полученный с помощью функционала "Отслеживаемые сущности".
Допустим на сайте, есть некая переменная url, укажем это в значении и введём понятное имя.
После создания и настройки сущности, можно перейти к добавлению в webhook.
В меню навигации, выберите Интеграция -> Webhooks и нажмите на добавление параметров.
В списке доступных параметров, выберите custom и укажите его имя и имя созданной сущности.
Передача статического параметра
Так же, Вы можете передать статический параметр вместе с оповещением. В большинстве ситуаций, он указывается не более, чем для идентификации приложения, из которого отправлено оповещение.
Обратите внимание! Передать статический параметр можно только методом GET, в url адресе обработчика.
В окне настройки Webhook запроса, перейдите в поле URL и добавьте статические параметры для передачи.
На примере показана передача 2х статических параметров – source и service
Обратите внимание! Метод отправки данных не имеет значения, т.к. параметры и их значение прописаны в URL-адресе, на который отправляется оповещение.
На этом настройка передачи пользовательского параметра завершена.
- Перед звонком
- Шаг переадресации
- В момент ответа
- После звонка
- После меню оценки
Параметры, доступные для передачи:
| Имя параметра | Описание параметра |
|---|---|
| Номер звонящего | Номер клиента, который позвонил или заказал обратный звонок |
| Куда звонили | Номер из пула подмены, на который позвонили |
| Дата | Дата и время звонка |
| Тип | Тип звонка: in |
| Какой по счёту звонок | Какой по счёту звонок от клиента |
| Имя пула |
Имя пула номеров
(как правило, указывает источник/канал к которому привязан номер) |
| Источник |
Источник перехода посетителя
UTM-метка – utm_source |
| Канал |
Канал трафика перехода посетителя
UTM-метка – utm_medium |
| Кампания |
Рекламная кампания перехода
UTM-метка – utm_campaign |
| Контент |
Содержимое объявления в кампании
UTM-метка – utm_content |
| Ключевое слово |
Ключевое слово объявления в РК
UTM-метка – utm_tеrm |
| UUID посетителя | Google Analytics Client ID посетителя |
| IP постетителя | IP-адрес посетителя |
| Google Analytics resource UUID | Идентификатор отслеживания Google Analytics |
| Уникальный (первый) звонок | Указывает, является ли звонок самым 1м с этого номера клиента |
| The number in E.164 format | Номер звонящего согласно международного стандарта формата номеров |
| Ответственные менеджеры | Список ID сотрудников, участвующих в распределении нагрузки по звонкам |
| ID Call | Уникальный ID звонка в Ringostat |
| Last Page | Страница, с которой совершён звонок |
| Тип подмены | Тип подмены: Динамический/Статический/Callback |
| custom | Пользовательский параметр захваченный на сайте |
"caller":"380441112233",
"callee":"380442223344",
"date":"2018-08-13 11:11:11",
"type":"in",
"number_call":"1",
"pool_name":"Основной пул, все переходы",
"source":"ringostat",
"medium":"support",
"campaign":"test",
"content":"webhhok_simple_test",
"term":"webhook",
"user_uuid":"669962468.1534189331",
"user_ip":"10.10.10.10",
"gaid":"UA-11111111-1",
"unique_first":"1",
"full_num":"+380441112233",
"manager":"4411;4416;4421;5364;5909;6164",
"call_id":"3333333333.3333333",
"last_page":"ringostat.ua/benefits",
"replace_type":"dynamic",
"custom":"https://ringostat.ua/benefits"
}
Параметры, доступные для передачи:
| Имя параметра | Описание параметра |
|---|---|
| Номер звонящего | Номер клиента, который позвонил или заказал обратный звонок |
| Куда звонили | Номер из пула подмены, на который позвонили |
| Дата | Дата и время звонка |
| Тип | Тип звонка: in |
| Какой по счёту звонок | Какой по счёту звонок от клиента |
| Имя пула |
Имя пула номеров
(как правило, указывает источник/канал к которому привязан номер) |
| Источник |
Источник перехода посетителя
UTM-метка – utm_source |
| Канал |
Канал трафика перехода посетителя
UTM-метка – utm_medium |
| Кампания |
Рекламная кампания перехода
UTM-метка – utm_campaign |
| Контент |
Содержимое объявления в кампании
UTM-метка – utm_content |
| Ключевое слово |
Ключевое слово объявления в РК
UTM-метка – utm_tеrm |
| UUID посетителя | Google Analytics Client ID посетителя |
| IP постетителя | IP-адрес посетителя |
| Шаг переадресации | Направление, на которое был переадресован звонок |
| Google Analytics resource UUID | Идентификатор отслеживания Google Analytics |
| Уникальный (первый) звонок | Указывает, является ли звонок самым 1м с этого номера клиента |
| Код сотрудника | Уникальный ID сотрудника в проекте |
| Ответственные менеджеры | Список ID сотрудников, участвующих в распределении нагрузки по звонкам |
| ID Call | Уникальный ID звонка в Ringostat |
| Last Page | Страница, с которой совершён звонок |
| Тип подмены | Тип подмены: Динамический/Статический/Callback |
| custom | Пользовательский параметр захваченный на сайте |
"caller":"380441112233",
"callee":"380442223344",
"date":"2018-08-13 11:11:11",
"type":"in",
"number_call":"1",
"pool_name":"Основной пул, все переходы",
"source":"ringostat",
"medium":"support",
"campaign":"test",
"content":"webhhok_simple_test",
"term":"webhook",
"user_uuid":"669962468.1534189331",
"user_ip":"10.10.10.10",
"route_step":"sip/supportringostat_example@sip.ringostat.com:30",
"gaid":"UA-11111111-1",
"unique_first":"1",
"manager_id":false,
"call_id":"3333333333.3333333",
"last_page":"ringostat.ua/benefits",
"replace_type":"dynamic",
"custom":"http://ringostat.ua/benefits"
}
Параметры, доступные для передачи:
| Имя параметра | Описание параметра |
|---|---|
| Номер звонящего | Номер клиента, который позвонил или заказал обратный звонок |
| Куда звонили | Номер из пула подмены, на который позвонили |
| Дата | Дата и время звонка |
| Тип | Тип звонка: in |
| С кем соединён | Номер или SIP-аккаунт менеджера, на котором он ответил на звонок |
| Какой по счёту звонок | Какой по счёту звонок от клиента |
| Имя пула |
Имя пула номеров
(как правило, указывает источник/канал к которому привязан номер) |
| Источник |
Источник перехода посетителя
UTM-метка – utm_source |
| Канал |
Канал трафика перехода посетителя
UTM-метка – utm_medium |
| Кампания |
Рекламная кампания перехода
UTM-метка – utm_campaign |
| Контент |
Содержимое объявления в кампании
UTM-метка – utm_content |
| Ключевое слово |
Ключевое слово объявления в РК
UTM-метка – utm_tеrm |
| UUID посетителя | Google Analytics Client ID посетителя |
| IP постетителя | IP-адрес посетителя |
| Google Analytics resource ID | Идентификатор отслеживания Google Analytics |
| Уникальный (первый) звонок | Указывает, является ли звонок самым 1м с этого номера клиента |
| Код сотрудника | Уникальный ID сотрудника в проекте |
| Ответственные менеджеры | Список ID сотрудников, участвующих в распределении нагрузки по звонкам |
| ID Call | Уникальный ID звонка в Ringostat |
| Last Page | Страница, с которой совершён звонок |
| Тип подмены | Тип подмены: Динамический/Статический/Callback |
| custom | Пользовательский параметр захваченный на сайте |
"caller":"380441112233",
"callee":"380442223344",
"date":"2018-08-13 11:11:11",
"type":"in",
"destination":"380443334455",
"number_call":"1",
"pool_name":"Основной пул, все переходы",
"source":"ringostat",
"medium":"support",
"campaign":"test",
"content":"webhhok_simple_test",
"term":"webhook",
"user_uuid":"669962468.1534189331",
"user_ip":"10.10.10.10",
"gaid":"UA-11111111-1",
"unique_first":"1",
"full_num":"+380441112233",
"manager_id":false,
"call_id":"3333333333.3333333",
"last_page":"ringostat.ua/benefits",
"replace_type":"dynamic",
"custom":"http://ringostat.ua/benefits"
}
Данный момент отправки самый популярный. Он позволяет получить практически все параметры, связанные с позвонившим клиентом, а также информацию о самом звонке.
Примеры использования момента отправки данных:
- Создавать сущность (задачу / контакт / лид / сделку) по результатам звонка;
- Закрепить сущность за менеджером, который ответил на звонок;
- Усилить контроль пропущенных звонков;
- Связать звонок с продажей.
Параметры, доступные для передачи:
| Имя параметра | Описание параметра |
|---|---|
| Номер звонящего | Номер клиента, который позвонил или заказал обратный звонок |
| Куда звонили | Номер из пула подмены, на который позвонили |
| Статус | Статус звонка |
| Дата | Дата и время звонка |
| Длительность | Общее время разговора и ожидания ответа |
| Тип | Тип звонка: in |
| Ожидание | Ожидание на линии до ответа |
| Разговор | Длительность разговора |
| С кем соединён | Номер или SIP-аккаунт менеджера, на котором он ответил на звонок |
| Какой по счёту звонок | Какой по счёту звонок от клиента |
| Целевой | Звонок, который соответствует критерию длительности в рамках Цикла продаж |
| Повторный | Повторный звонок от клиента |
| Имя пула |
Имя пула номеров
(как правило, указывает источник/канал к которому привязан номер) |
| Источник |
Источник перехода посетителя
UTM-метка – utm_source |
| Канал |
Канал трафика перехода посетителя
UTM-метка – utm_medium |
| Кампания |
Рекламная кампания перехода
UTM-метка – utm_campaign |
| Контент |
Содержимое объявления в кампании
UTM-метка – utm_content |
| Ключевое слово |
Ключевое слово объявления в РК
UTM-метка – utm_tеrm |
| Запись | Уникальный ID звонка в Ringostat |
| UUID посетителя | Google Analytics Client ID посетителя |
| IP постетителя | IP-адрес посетителя |
| Google Analytics resource UUID | Идентификатор отслеживания Google Analytics |
| Ссылка на аудиозапись | Ссылка на аудиозапись разговора |
| Уникальный (первый) звонок | Указывает, является ли звонок самым 1м с этого номера клиента |
| Уникальный целевой звонок | Указывает, является ли звонок 1м и при этом целевым с этого номера клиента |
| Первый целевой звонок | Самый 1й целевой звонок с данного номера |
| The number in E.164 format | Номер звонящего согласно международного стандарта формата номеров |
| Код сотрудника | Уникальный ID сотрудника в проекте |
| Ответственные менеджеры | Список ID сотрудников, участвующих в распределении нагрузки по звонкам |
| ID Call | Уникальный ID звонка в Ringostat |
| Roistat Visit ID | Номер визита Roistat |
| Лэндинг | Страница входа на сайт |
| Last Page | Страница, с которой совершён звонок |
| Тип подмены | Тип подмены: Динамический/Статический/Callback |
| custom | Пользовательский параметр захваченный на сайте |
"caller":"380441112233",
"callee":"380442223344",
"status":"PROPER",
"date":"2018-08-13 11:11:11",
"call_duration":61,
"type":"in",
"waiting":43,
"dialog":18,
"destination":"380443334455",
"number_call":1,
"proper":1,
"repeated":0,
"pool_name":"Основной пул, все переходы",
"source":"ringostat",
"medium":"support",
"campaign":"test",
"content":"webhhok_simple_test",
"term":"webhook",
"record":"3333333333.3333333",
"user_uuid":"669962468.1534189331",
"user_ip":"10.10.10.10",
"gaid":"UA-11111111-1",
"record_link":"https://app.ringostat.com/recordings/3333333333.3333333.ogg?token=n4w3htn38hssugrwgbcd",
"unique_first":1,
"unique_proper":1,
"first_proper":1,
"full_num":"+380441112233",
"manager_id":"6164",
"manager":"4411;4416;4421;5364;5909;6164",
"call_id":"3333333333.3333333",
"roistat_visit_id":"17541",
"landing":"ringostat.com/?utm_source=ringostat&utm_medium=support&utm_campaign=test&utm_term=webhook&utm_content=webhhok_simple_test",
"last_page":"ringostat.ua/benefits",
"replace_type":"dynamic",
"custom":"https://ringostat.ua/benefits"
}
Данный момент отправки оповещений будет удобен, если Вы используете функционал " Категоризации звонков.
Момент отправки включает в себя все параметры, которые возможно передать после звонка, а так же категории, ценность и код сотрудника, который указал эти параметры в меню категорий звонка.
Параметры, доступные для передачи:
| Имя параметра | Описание параметра |
|---|---|
| Номер звонящего | Номер клиента, который позвонил или заказал обратный звонок |
| Куда звонили | Номер из пула подмены, на который позвонили |
| Статус | Статус звонка |
| Дата | Дата и время звонка |
| Ценность | Ценность звонка, которую устанавливает менеджер в меню оценки звонка |
| Длительность | Общее время разговора и ожидания ответа |
| Тип | Тип звонка: in |
| Ожидание | Ожидание на линии до ответа |
| Разговор | Длительность разговора |
| С кем соединён | Номер или SIP-аккаунт менеджера, на котором он ответил на звонок |
| Какой по счёту звонок | Какой по счёту звонок от клиента |
| Целевой | Звонок, который соответствует критерию длительности в рамках Цикла продаж |
| Повторный | Повторный звонок от клиента |
| Имя пула |
Имя пула номеров
(как правило, указывает источник/канал к которому привязан номер) |
| Источник |
Источник перехода посетителя
UTM-метка – utm_source |
| Канал |
Канал трафика перехода посетителя
UTM-метка – utm_medium |
| Кампания |
Рекламная кампания перехода
UTM-метка – utm_campaign |
| Контент |
Содержимое объявления в кампании
UTM-метка – utm_content |
| Ключевое слово |
Ключевое слово объявления в РК
UTM-метка – utm_tеrm |
| Запись | Уникальный ID звонка в Ringostat |
| Категория звонка | Категория звонка, которую устанавливает менеджер в меню оценки звонка |
| UUID посетителя | Google Analytics Client ID посетителя |
| IP постетителя | IP-адрес посетителя |
| Google Analytics resource UUID | Идентификатор отслеживания Google Analytics |
| Ссылка на аудиозапись | Ссылка на аудиозапись разговора |
| Уникальный (первый) звонок | Указывает, является ли звонок самым 1м с этого номера клиента |
| Уникальный целевой звонок | Указывает, является ли звонок 1м и при этом целевым с этого номера клиента |
| Первый целевой звонок | Самый 1й целевой звонок с данного номера |
| The number in E.164 format | Номер звонящего согласно международного стандарта формата номеров |
| Код сотрудника | Уникальный ID сотрудника в проекте |
| Ответственные менеджеры | Список ID сотрудников, участвующих в распределении нагрузки по звонкам |
| ID Call | Уникальный ID звонка в Ringostat |
| Roistat Visit ID | Номер визита Roistat |
| Лэндинг | Страница входа на сайт |
| Last Page | Страница, с которой совершён звонок |
| Тип подмены | Тип подмены: Динамический/Статический/Callback |
| custom | Пользовательский параметр захваченный на сайте |
"caller":"380441112233",
"callee":"380442223344",
"status":"PROPER",
"date":"2018-08-13 11:11:11",
"value":55,
"call_duration":61,
"type":"in",
"waiting":43,
"dialog":18,
"destination":"380443334455",
"number_call":1,
"proper":1,
"repeated":0,
"pool_name":"Основной пул, все переходы",
"source":"ringostat",
"medium":"support",
"campaign":"test",
"content":"webhhok_simple_test",
"term":"webhook",
"record":"3333333333.3333333",
"call_category":1,
"user_uuid":"669962468.1534189331",
"user_ip":"10.10.10.10",
"gaid":"UA-11111111-1",
"record_link":"https://app.ringostat.com/recordings/3333333333.3333333.ogg?token=n4w3htn38hssugrwgbcd",
"unique_first":1,
"unique_proper":1,
"first_proper":1,
"full_num":"+380441112233",
"manager_id":"6164",
"manager":"4411;4416;4421;5364;5909;6164",
"call_id":"3333333333.3333333",
"roistat_visit_id":"17541",
"landing":"ringostat.com/?utm_source=ringostat&utm_medium=support&utm_campaign=test&utm_term=webhook&utm_content=webhhok_simple_test",
"last_page":"ringostat.ua/benefits",
"replace_type":"dynamic",
"custom":"http://ringostat.ua/benefits"
}
Отправка оповещений по исходящим звонкам может стать одной из главных составляющих автоматизации рутинной работы менеджеров в crm-системе, а так же контроля их работы с пропущенными звонками.
Примеры обработки оповещений перед исходящим звонком
- вызвать карточку контакта из crm-системы;
- добавить данные о звонке в карточку контакта, в crm-системе;
- создать сущность в crm-системе(задача / контакт / лид / сделка);
- закрепить сущность за звонящим менеджером;
- контроллировать исходящие звонки менеджеров;
- контроллировать перезвон по пропущенным звонкам;
- Перед звонком
- После звонка
Параметры, доступные для передачи:
| Имя параметра | Описание параметра |
|---|---|
| Номер звонящего | Логин и отображаемое имя SIP-аккаунта |
| Куда звонили | Номер, на который звонил менеджер |
| Тип | Тип звонка: Out |
| Google Analytics resource UUID | Идентификатор отслеживания Google Analytics |
| The number in E.164 format |
Номер звонящего согласно международного стандарта формата номеров
выводится логин сипа, из-под которого совершён звонок |
"caller":""Support PhonerLite" <supportringostat_example>",
"callee":"380441112233",
"type":"out",
"gaid":"UA-11111111-1",
"full_num":"+"Support PhonerLite" <supportringostat_example>"
}
Параметры, доступные для передачи:
| Имя параметра | Описание параметра |
|---|---|
| Номер звонящего | Логин и отображаемое имя SIP-аккаунта |
| Куда звонили | Номер, на который звонил менеджер |
| Статус | Статус исходящего звонка |
| Дата | Дата и время звонка |
| Ценность | Ценность звонка, которую устанавливает менеджер во входящем звонке с этого номера |
| Длительность | Общее время разговора и ожидания ответа |
| Тип | Тип звонка: Out |
| Ожидание | Ожидание на линии до ответа |
| Разговор | Длительность разговора |
| Запись | Уникальный ID звонка в Ringostat |
| Google Analytics resource ID | Идентификатор отслеживания Google Analytics |
| Ссылка на аудиозапись | Ссылка на запись разговора |
| The number in E.164 format |
Номер звонящего согласно международного стандарта формата номеров
выводится логин сипа, из-под которого совершён звонок |
| ID Call | Уникальный ID звонка в Ringostat |
"callee":""Support PhonerLite" <supportringostat_example>",
"caller":"380441112233",
"status":"ANSWERED",
"date":"2018-08-13 11:11:11",
"value":0,
"call_duration":50,
"type":"out",
"waiting":27,
"dialog":23,
"record":"3333333333.3333333",
"gaid":"UA-11111111-1",
"record_link":"https://app.ringostat.com/recordings/3333333333.3333333.ogg?token=n4w3htn38hssugrwgbcd",
"full_num":"+"Support PhonerLite" <supportringostat_example>",
"call_id":"3333333333.3333333"
}