Webhook — механизм передачи уведомлений об определённых событиях, которые получены и зафиксированы в Ringostat.
Благодаря такому механизму, систему аналитики звонков Ringostat можно интегрировать с другими сервисами и сторонними веб-приложениями.
Настройка отправки Webhook.
Для того, чтобы включить отправку событий из Ringostat в вашу CRM необходимо создать новый вебхук, с произвольным названием, и указать для него следующие значения.
URL — веб-адрес CRM или другого обработчика, на который будет отправляться запрос. Протокол может быть как http, так и https.
Существует логическая связь между тем, какие данные содержит вебхук и когда он может быть отправлен. Необходимо выбрать подходящий для реализации вашей задачи момент отправки вебхука.
Что такое момент отправки данных?
В работе сервиса Ringostat предусмотрено несколько моментов отправки данных. Простыми словами это события, являющиеся сигналом для отправки хука.
Перед входящим звонком.
Используется для получения предварительных данных о предстоящем звонке. Например, ключевое слово или канал рекламы по которому перешел пользователь.
После завершения входящего звонка.
Передаются практически все параметры, связанные с позвонившим клиентом, а также информация о самом звонке. Например, номер звонящего, регион, длительность, статус звонка, запись разговора и т.п.
Каждый шаг переадресации звонка.
Передает тот блок настроенной вами схемы переадресации, который будет задействован при конкретном сценарии распределения вызова.
Ответ на звонок (в момент поднятия трубки).
Используется для уведомления о звонке только ответственного менеджера.
После завершение оценки разговора (меню категорий звонка).
Используется для передачи категории и ценности звонка, а также имени/id менеджера, который принял звонок.
События связанные с исходящими звонками:
- перед (инициализация) исходящим звонком;
- завершение исходящего звонка (положили рубку).
Метод отправки данных выбирайте соответственно с документацией по интеграции вашей CRM.
Это может быть:
- GET
- POST
- PUT
- DELETE
Аналогично, вы можете использовать один из форматов обмена данными поддерживаемых вашим приложением (Http; Json; Xml) и формат даты.
Настройки интеграции WebHooks с внешними системами:
Интеграция⟹Webhooks⟹Добавить новую интеграцию
В данном интерфейсе вы можете создавать новые вебхуки или редактировать существующие.
По умолчанию у вас будет создан и настроен хук интеграции с Google Universal Analytics. А также других автоматических интеграций (например AmoCrm), если они включены.
После нажатия на кнопку "Добавить новую интеграцию", необходимо указать описанные выше поля.
Настройка передаваемых параметров.
Путем отправки webhook из сервиса Ringostat можно передавать в вашу CRM около 40 различных параметров.
Настройте необходимые параметры webhook:
Интеграция⟹Webhooks⟹Настроить существующий Webhook (пиктограмма шестиренки)
Передаваемые параметры:
- имя параметра — следует указать имя параметра, которое будет добавлено в URL. Корректное имя параметров, с которыми может работать ваша система, указано в соответствующей документации или требует уточнения у службы поддержки;
- значение параметра — выберите те данные в выпадающем списке, которые вы хотите передавать с тем или иным событием, и которые поддерживаются вашей системой.
Параметры которые возможно передавать по Webhook при входящих звонках.
| Параметры |
Перед звонком |
После звонка |
После меню оценки звонка |
В момент поднятия трубки |
Шаг переадресации |
Описание |
| Номер звонящего | + | + | + | + | + | номер телефона звонящего |
| Куда звонили | + | + | + | + | + | номер из пула номеров для подмены на сайте |
| Статус | — | + | + | — | — | статус звонка - например, отвечен или неудавшийся |
| Дата | + | + | + | + | + | дата звонка |
| Ценность | — | — | + | — | — | ценность звонка |
| Длительность | — | + | + | — | — | общее время разговора и ожидания на линии |
| Тип | + | + | + | + | + | тип звонка - входящий или исходящий |
| Ожидание | — | + | + | — | — | ожидание на линии до соединения с оператором |
| Разговор | — | + | + | — | — | длительность разговора |
| С кем соединен | — | + | + | + | — | конечный номер оператора с которым соединят клиента |
| Какой по счету звонок | + | + | + | + | + | первый или повторный звонок |
| Целевой | — | + | + | — | — | звонок, который соответствует определенным критериям |
| Повторный | — | + | + | — | — | повторный звонок от клиента |
| Источник | + | + | + | + | + | источник перехода на сайт |
| Канал | + | + | + | + | + | канал перехода на сайт |
| Кампания | + | + | + | + | + | рекламная кампания |
| utm_content | + | + | + | + | + | идентифицирует конкретную ссылку или элемент контента в кампании. |
| Ключевое слово | + | + | + | + | + | ключевое слово перехода на сайт |
| Регион | + | + | + | + | + | регион номера из пула номеров для подмены на сайте |
| Запись | — | + | + | — | — | уникальный ID звонка в Ringostat |
| Категория звонка | — | — | + | — | — | оценка звонка, которую дает оператор после разговора с клиентом |
| Регион звонящего | + | + | + | + | + | регион номера звонящего |
| UUID посетителя | + | + | + | + | + | Google Analytics Client ID |
| IP посетителя | + | + | + | + | + | IP адрес посетителя |
| Шаг переадресации | — | — | — | — | + | этап распределения вызова |
| Google Analytics resource ID | + | + | + | + | + | идентификатор ресурса в Google Analytics |
| Ссылка на аудиозапись | — | + | + | — | — | ссылка на запись разговора |
| Уникальный (первый) звонок | + | + | + | + | + | самый первый звонок с данного номера |
| Уникальный целевой звонок | — | + | + | — | — | первый и при этом целевой звонок с данного номера |
| Первый целевой звонок | — | + | + | — | — | первый целевой звонок с данного номера |
| Номер в формате E.164 | + | + | + | + | + |
Передача номера звонящего(клиента). Номера по E.164(международный стандарт формата номеров) могут иметь максимум 15 цифр и обычно записываются с префиксом «+». пример: Украина – +380441112233 Казахстан – +77271112233 РФ – +74991112233 |
| ID менеджера | — | + | + | + | + | уникальный ID сотрудника проекта |
| Добавочный номер | — | — | — | — | — | дополнительный внутренний номер |
| ID Call | + | + | + | + | + | уникальный ID звонка в Ringostat |
| Ответственные менеджеры | + | + | + | + | + | список ID сотрудников, участвующих в распределении нагрузки по звонкам |
| Roistat visit ID | + | + | + | — | — | Roistat visit ID |
| Landing | — | + | + | — | — | Адрес страницы с которой позвонил клиент. |
Параметры которые возможно передавать по Webhook при исходящих звонках.
| Параметры | до звонка | после звонка | Описание |
| Номер звонящего | + | + | номер телефона звонящего |
| Куда звонили | + | + | номер из пула номеров для подмены на сайте |
| Статус | — | + | статус звонка - например, отвечен или неудавшийся |
| Дата | — | + | дата звонка |
| Ценность | — | + | ценность звонка |
| Длительность | — | + | общее время разговора и ожидания на линии |
| Тип | + | + | тип звонка - входящий или исходящий |
| Ожидание | — | + | ожидание на линии до соединения с оператором |
| Разговор | — | + | длительность разговора |
| С кем соединен | — | — | конечный номер оператора с которым соединят клиента |
| Какой по счету звонок | — | — | первый или повторный звонок |
| Целевой | — | — | звонок, который соответствует определенным критериям |
| Повторный | — | — | повторный звонок от клиента |
| Источник | — | — | источник перехода на сайт |
| Канал | — | — | канал перехода на сайт |
| Кампания | — | — | рекламная кампания |
| utm_content | — | — | идентифицирует конкретную ссылку или элемент контента в кампании. |
| Ключевое слово | — | — | ключевое слово перехода на сайт |
| Регион | — | — | регион номера из пула номеров для подмены на сайте |
| Запись | — | + | уникальный ID звонка в Ringostat |
| Категория звонка | — | — | оценка звонка, которую дает оператор после разговора с клиентом |
| Регион звонящего | — | — | регион номера звонящего |
| UUID посетителя | — | — | Google Analytics Client ID |
| IP посетителя | — | — | IP адрес посетителя |
| Шаг переадресации | — | — | этап распределения вызова |
| Google Analytics resource ID | + | + | идентификатор ресурса в Google Analytics |
| Ссылка на аудиозапись | — | + | ссылка на запись разговора |
| Уникальный (первый) звонок | — | + | самый первый звонок с данного номера |
| Уникальный целевой звонок | — | + | первый и при этом целевой звонок с данного номера |
| Первый целевой звонок | — | + | первый целевой звонок с данного номера |
| Номер в формате E.Да64 | + | + | международный стандарт формата телефонных номеров |
| ID менеджера | — | — | уникальный ID сотрудника проекта |
| Добавочный номер | — | — | дополнительный внутренний номер |
| ID Call | — | + | уникальный ID звонка в Ringostat |
| Ответственные менеджеры | — | — | список ID сотрудников, участвующих в распределении нагрузки по звонкам |
| for roistat (aftercall) | — | — | Roistat visit ID |
| Landing | — | — | Landing page |
ВАЖНО!
Некоторые параметры невозможно передавать при выборе того или иного момента отправки, поэтому при настройке интеграции, система не даст возможности их выбрать. Например, нельзя передать “длительность разговора”, когда момент отправки уведомления установлен “перед звонком”.
Также, кроме данных о звонке, в поле выбора возможных значений есть параметр "UUID посетителя" — это Client id посетителя в Google Analytics . Этот вариант работает только для динамического коллтрекинга. Если у вас не включена подмена номеров по сессии пользователя, то будет генерироваться случайный идентификатор посетителя.
Добавление IP адресов в исключение
Все отправленные webhook запросы могут быть отправлены с разных IP адресов серверов 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
Будем рады ответить на ваши вопросы в чате или на email: Support Team