Интеграция Ringostat с помощью Webhooks

Webhook – механизм оповещений системы и/или сторонних систем, о событиях телефонии или Виртуальной АТС Ringostat в определённый момент.

При возникновении события, созданный ранее в ЛК, webhook-обработчик отправляет HTTP-запрос с набором параметров на URL, который был указан для этого Webhook.

Если URL, на который отправляется Webhook, недоступен (отвечает не HTTP 200 OK), попыток повторной отправки Webhook на этот URL до получения ожидаемого 200 ОК не будет. Webhook будет отмечен "с ошибкой", его статус отправки и ошибку можно будет просмотреть на странице Проверка ошибок Webhooks

WebHooks - упрощенный вариант rest-событий и rest-команд, не требующий написания приложения. Но, даже не смотря на это, работа с REST — это непростая задача, требующая солидной квалификации от разработчика.

Событие – " Входящий звонок "
- перед звонком;
- после звонка;
- после меню оценки звонка;
- в момент поднятия трубки
- шаг переадресации
Событие – " Исходящий звонок "
- перед звонком;
- после звонка;

Создание 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

В случае, если сервер Ringostat на отправку webhook's получает неуспешный статус код (4ХХ-5ХХ) – он будет помещён в очередь и повторно отправлен ещё 3 раза с интервалом в 10 минут.
Если все попытки отправки были неуспешны на странице "Проверка ошибок Webhook" будет добавлена соответствующая запись.

Страница со списком интеграций содержит кнопку, по клику на которую будет выполнен переход на страницу с 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
91.223.223.51
91.239.234.66
193.169.188.64

Описание событий, моментов отправки данных и доступных параметров

Событие – "Входящий звонок"
Событие – "Исходящий звонок"

Событие " Входящий звонок" включает 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-адрес посетителя
Номер в формате E.164	Номер в формате E.164. Номера по E.164 могут иметь максимум 15 цифр и обычно записываются с префиксом «+».
Google Analytics resource UUID	Идентификатор отслеживания Google Analytics
Уникальный (первый) звонок	Указывает, является ли звонок самым 1м с этого номера клиента
Ответственные менеджеры	Список ID сотрудников, участвующих в распределении нагрузки по звонкам
ID звонка	Уникальный ID звонка в Ringostat
Последняя просмотренная страница	Страница, с которой совершён звонок
Тип подмены	Тип подмены: Динамический/Статический/Callback
Реферер	Ресурс/Источник, с которого пришёл посетитель
Схема переадресации	Название схемы переадерсации, на которую был направлен звонок
Дата звонка (микросекунды)	Дата звонка указанная в микросекундах
Roistat Visit Id	Id отслеживания посетителя Roistat, если есть активная интеграция с Roistat
Custom	Параметр для передачи пользовательских отслеживаемых сущностей
User agent	Все данные об устройстве пользователя, а также о браузере перехода
ID проекта	ID вашего проекта в сервисе Ringostat
Добавочный номер	Добавочный номер, введенный клиентом в голосовом меню IVR
Первый заполненный параметр	Первый заполненный параметр. Если вы выбираете два и более параметров, система отправит по вебхуку тот из них, который будет получен системой первым.

{
"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",
"E164":"+380561234567",
"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"
"referrer":"https://www.google.com/"
"calldate_timestamp_micros":“1230219000000000”,
"roistatid":“666666”,
"useragent":“Mozilla/5.0 (Linux; Android 8.0.0; LND-L29 Build/HONORLND-L29; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/96.0.4664.45 Mobile Safari/537.36”,
"project_id": “0000”,
"add_num_id":“102"
}

Параметры, доступные для передачи:

Имя параметра	Описание параметра
Номер звонящего	Номер клиента, который позвонил или заказал обратный звонок
Куда звонили	Номер из пула подмены, на который позвонили
Дата	Дата и время звонка
Тип	Тип звонка: in
Какой по счёту звонок	Какой по счёту звонок от клиента
Имя пула	Имя пула номеров (как правило, указывает источник/канал к которому привязан номер)
Источник	Источник перехода посетителя UTM-метка – utm_source
Канал	Канал трафика перехода посетителя UTM-метка – utm_medium
Кампания	Рекламная кампания перехода UTM-метка – utm_campaign
Контент	Содержимое объявления в кампании UTM-метка – utm_content
Ключевое слово	Ключевое слово объявления в РК UTM-метка – utm_tеrm
ID проекта	ID вашего проекта в сервисе Ringostat
UUID посетителя	Google Analytics Client ID посетителя
IP постетителя	IP-адрес посетителя
Шаг переадресации	Направление, на которое был переадресован звонок
Google Analytics resource UUID	Идентификатор отслеживания Google Analytics
Уникальный (первый) звонок	Указывает, является ли звонок самым 1м с этого номера клиента
Ответственные менеджеры	Список ID сотрудников, участвующих в распределении нагрузки по звонкам
ID звонка	Уникальный ID звонка в Ringostat
Последняя просмотренная страница	Страница, с которой совершён звонок
Тип подмены	Тип подмены: Динамический/Статический/Callback
Custom	Пользовательский параметр захваченный на сайте
Реферер	Ресурс/источник, с которого пришёл посетитель
Схема переадресации	Название схемы переадерсации, на которую был направлен звонок
Дата звонка (микросекунды)	Дата звонка указанная в микросекундах
Номер в формате E.164	Номер в формате E.164. Номера по E.164 могут иметь максимум 15 цифр и обычно записываются с префиксом «+».
Код сотрудника	ID сотрудника вашего проекта
User agent	Все данные об устройстве пользователя, а также о браузере перехода
Первый заполненный параметр	Первый заполненный параметр. Если вы выбираете два и более параметров, система отправит по вебхуку тот из них, который будет получен системой первым.

{
"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",
"project_id": "1000"
"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"
"referrer":"https://www.google.com/"
"scheme":"Основная"
"calldate_timestamp_micros":“1230219000000000”,
"E164":"+380561234567",
"agent_id":"1111"
"useragent":“Mozilla/5.0 (Linux; Android 8.0.0; LND-L29 Build/HONORLND-L29; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/96.0.4664.45 Mobile Safari/537.36”
}

Параметры, доступные для передачи:

Имя параметра	Описание параметра
Номер звонящего	Номер клиента, который позвонил или заказал обратный звонок
Куда звонили	Номер из пула подмены, на который позвонили
Дата	Дата и время звонка
Тип	Тип звонка: in
С кем соединён	Номер или SIP-аккаунт менеджера, на котором он ответил на звонок
Какой по счёту звонок	Какой по счёту звонок от клиента
Имя пула	Имя пула номеров (как правило, указывает источник/канал к которому привязан номер)
Источник	Источник перехода посетителя UTM-метка – utm_source
Канал	Канал трафика перехода посетителя UTM-метка – utm_medium
Кампания	Рекламная кампания перехода UTM-метка – utm_campaign
Контент	Содержимое объявления в кампании UTM-метка – utm_content
Ключевое слово	Ключевое слово объявления в РК UTM-метка – utm_tеrm
Добавочный номер	Добавочный номер, введенный клиентом в голосовом меню IVR
UUID посетителя	Google Analytics Client ID посетителя
IP постетителя	IP-адрес посетителя
Google Analytics resource ID	Идентификатор отслеживания Google Analytics
Уникальный (первый) звонок	Указывает, является ли звонок самым 1м с этого номера клиента
Ответственные менеджеры	Список ID сотрудников, участвующих в распределении нагрузки по звонкам
ID звонка	Уникальный ID звонка в Ringostat
Последняя просмотренная страница	Страница, с которой совершён звонок
Тип подмены	Тип подмены: Динамический/Статический/Callback
Custom	Пользовательский параметр захваченный на сайте
Реферер	Ресурс/источник, с которого пришёл посетитель
Схема переадресации	Название схемы переадерсации, на которую был направлен звонок
Дата звонка (микросекунды)	Дата звонка указанная в микросекундах
Номер в формате E.164	Номер в формате E.164. Номера по E.164 могут иметь максимум 15 цифр и обычно записываются с префиксом «+».
Код сотрудника	ID сотрудника вашего проекта
User agent	Все данные об устройстве пользователя, а также о браузере перехода
ID проекта	ID вашего проекта в сервисе Ringostat
Первый заполненный параметр	Первый заполненный параметр. Если вы выбираете два и более параметров, система отправит по вебхуку тот из них, который будет получен системой первым.

{
"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"
"referrer":"https://www.google.com/"
"scheme":"Основная"
"calldate_timestamp_micros":“1230219000000000”,
"E164":"+380561234567",
"agent_id":"1111"
"add_num_id":“102"
"useragent":“Mozilla/5.0 (Linux; Android 8.0.0; LND-L29 Build/HONORLND-L29; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/96.0.4664.45 Mobile Safari/537.36”
"project_id": "1000"
}

Данный момент отправки самый популярный. Он позволяет получить практически все параметры, связанные с позвонившим клиентом, а также информацию о самом звонке.

Примеры использования момента отправки данных:

Создавать сущность (задачу / контакт / лид / сделку) по результатам звонка;
Закрепить сущность за менеджером, который ответил на звонок;
Усилить контроль пропущенных звонков;
Связать звонок с продажей.

Параметры, доступные для передачи:

Имя параметра	Описание параметра
Номер звонящего	Номер клиента, который позвонил или заказал обратный звонок
Куда звонили	Номер из пула подмены, на который позвонили
Статус	Статус звонка
Дата	Дата и время звонка
Длительность	Общее время разговора и ожидания ответа
Тип	Тип звонка: 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
Ссылка на аудиозапись (ogg)	Ссылка на аудиозапись разговора в формате ogg
Уникальный (первый) звонок	Указывает, является ли звонок самым 1м с этого номера клиента
Уникальный целевой звонок	Указывает, является ли звонок 1м и при этом целевым с этого номера клиента
Первый целевой звонок	Самый 1й целевой звонок с данного номера
Номер в формате E.164	Номер в формате E.164. Номера по E.164 могут иметь максимум 15 цифр и обычно записываются с префиксом «+».
Код сотрудника	ID сотрудника вашего проекта
Ответственные менеджеры	Список ID сотрудников, участвующих в распределении нагрузки по звонкам
ID звонка	Уникальный ID звонка в Ringostat
Лэндинг	Страница входа на сайт
Последняя просмотренная страница	Страница, с которой совершён звонок
Тип подмены	Тип подмены: Динамический/Статический/Callback
Custom	Пользовательский параметр захваченный на сайте
Реферер	Ресурс/источник, с которого пришёл посетитель
Схема переадресации	Название схемы переадерсации, на которую был направлен звонок
Есть запись	Параметр принимает значение 0 или 1 в зависимости от того, есть ли запись звонка
Карточка звонка	Ссылка на карточку звонка номера, с которого или на который был совершён звонок
Сотрудник	ФИО сотрудника, который обработал звонок
Отдел	Название отдела, в котором находится сотрудник, который обработал звонок
Дата звонка (микросекунды)	Дата звонка указанная в микросекундах
Ссылка на аудиозапись (wav)	Ссылка на аудиозапись в wav формате
Roistat Visit Id	Id отслеживания посетителя Roistat, если есть активная интеграция с Roistat
Добавочный номер	Добавочный номер, введенный клиентом в голосовом меню IVR
User agent	Все данные об устройстве пользователя, а также о браузере перехода
ID проекта	ID вашего проекта в сервисе Ringostat
Длительность в миллисекундах	Длительность звонка в миллисекундах
Первый заполненный параметр	Первый заполненный параметр. Если вы выбираете два и более параметров, система отправит по вебхуку тот из них, который будет получен системой первым.

Типы значений параметра “Статус звонка”:

Тип значения	Статус в журнале звонков	Описание
ANSWERED	Отвечен	не целевой звонок, на который ответил менеджер
BUSY	Занято	направления, на которые производилась переадресация, были заняты
CLIENT NO ANSWER	Нет ответа клиента	присваивается звонкам в том случае, если клиент заказал на сайте обратный звонок и не ответил на него/сбросил.
FAILED	С ошибками	присваивается звонкам в том случае, если при переадресации был сбой от оператора связи или сип-аккаунты, что указаны в схеме переадресации, находились оффлайн во время звонка
NO ANSWER	Нет ответа	звонок пропущен менеджером
NO EXTENSION	Не введён добавочный номер	звонящий вообще не ввёл добавочный номер (в последней попытке, если настроено несколько попыток), после попадания на голосовое меню
NO-FORWARD PROPER	Не сработала схема переадресации	звонок, который поступил на номер телефона без назначенной схемы переадресации или со схемой, настроенной с ошибкой
REPEATED	Повторный	отвеченный повторный вызов после целевого звонка
VOICEMAIL	Голосовая почта	звонок, который поступил на голосовую почту
FAILED FORBIDDEN DESTINATION	Запрещенное направление	присваивается звонкам с виджета Callback, если была попытка звонка на закрытое направление (например в проекте разрешены звонки только по Казахстану, а звонок был в США)
WRONG EXTENSION	Неправильно введён добавочный номер	звонящий ввёл некорректный добавочный номер, после попадания на голосовое меню

{
"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.33...
"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"
"referrer":"https://www.google.com/"
"scheme":"Основная"
"has_recording":"0"
"call_card":"https://app.ringostat.com/project/callcards/card/....
"employee_fio":"Иван Иванов"
"department":"Отдел продаж"
"calldate_timestamp_micros":“1230219000000000”,
"recording_wav":"https://app.ringostat.com/recordings/ua8_-11111111111.1111111.wav?token=462908f128343fc23862397ddd638953"
"roistatid":“666666”,
"add_num_id":“102"
"useragent":“Mozilla/5.0 (Linux; Android 8.0.0; LND-L29 Build/HONORLND-L29; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/96.0.4664.45 Mobile Safari/537.36”
"project_id": "1000"
}

Данный момент отправки оповещений будет удобен, если Вы используете функционал " Категоризации звонков.

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

Параметры, доступные для передачи:

Имя параметра	Описание параметра
Номер звонящего	Номер клиента, который позвонил или заказал обратный звонок
Куда звонили	Номер из пула подмены, на который позвонили
Статус	Статус звонка
Дата	Дата и время звонка
Ценность	Ценность звонка, которую устанавливает менеджер в меню оценки звонка
Длительность	Общее время разговора и ожидания ответа
Тип	Тип звонка: 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
Ссылка на аудиозапись (ogg)	Ссылка на аудиозапись разговора в формате ogg
Уникальный (первый) звонок	Указывает, является ли звонок самым 1м с этого номера клиента
Уникальный целевой звонок	Указывает, является ли звонок 1м и при этом целевым с этого номера клиента
Первый целевой звонок	Самый 1й целевой звонок с данного номера
Номер в формате E.164	Номер в формате E.164. Номера по E.164 могут иметь максимум 15 цифр и обычно записываются с префиксом «+».
Код сотрудника	ID сотрудника вашего проекта
Ответственные менеджеры	Список ID сотрудников, участвующих в распределении нагрузки по звонкам
ID звонка	Уникальный ID звонка в Ringostat
Лэндинг	Страница входа на сайт
Последняя просмотренная страница	Страница, с которой совершён звонок
Тип подмены	Тип подмены: Динамический/Статический/Callback
Custom	Пользовательский параметр захваченный на сайте
Реферер	Ресурс/источник, с которого пришёл посетитель
Схема переадресации	Название схемы переадерсации, на которую был направлен звонок
Есть запись	Параметр принимает значение 0 или 1 в зависимости от того, есть ли запись звонка
Карточка звонка	Ссылка на карточку звонка номера, с которого или на который был совершён звонок
Дата звонка (микросекунды)	Дата звонка указанная в микросекундах
Ссылка на аудиозапись (wav)	Ссылка на аудиозапись в wav формате
Roistat Visit Id	Id отслеживания посетителя Roistat, если есть активная интеграция с Roistat
User agent	Все данные об устройстве пользователя, а также о браузере перехода
ID проекта	ID вашего проекта в сервисе Ringostat
Длительность в миллисекундах	Длительность звонка в миллисекундах
Первый заполненный параметр	Первый заполненный параметр. Если вы выбираете два и более параметров, система отправит по вебхуку тот из них, который будет получен системой первым.

Типы значений параметра “Статус звонка”:

Тип значения	Статус в журнале звонков	Описание
ANSWERED	Отвечен	не целевой звонок, на который ответил менеджер
BUSY	Занято	направления, на которые производилась переадресация, были заняты
CLIENT NO ANSWER	Нет ответа клиента	присваивается звонкам в том случае, если клиент заказал на сайте обратный звонок и не ответил на него/сбросил.
FAILED	С ошибками	присваивается звонкам в том случае, если при переадресации был сбой от оператора связи или сип-аккаунты, что указаны в схеме переадресации, находились оффлайн во время звонка
NO ANSWER	Нет ответа	звонок пропущен менеджером
NO EXTENSION	Не введён добавочный номер	звонящий вообще не ввёл добавочный номер (в последней попытке, если настроено несколько попыток), после попадания на голосовое меню
NO-FORWARD PROPER	Не сработала схема переадресации	звонок, который поступил на номер телефона без назначенной схемы переадресации или со схемой, настроенной с ошибкой
REPEATED	Повторный	отвеченный повторный вызов после целевого звонка
VOICEMAIL	Голосовая почта	звонок, который поступил на голосовую почту
FAILED FORBIDDEN DESTINATION	Запрещенное направление	присваивается звонкам с виджета Callback, если была попытка звонка на закрытое направление (например в проекте разрешены звонки только по Казахстану, а звонок был в США)
WRONG EXTENSION	Неправильно введён добавочный номер	звонящий ввёл некорректный добавочный номер, после попадания на голосовое меню

{
"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.33...
"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"
"referrer":"https://www.google.com/"
"scheme":"Основная"
"has_recording":"0"
"call_card":"https://app.ringostat.com/project/callcards/card/....
"calldate_timestamp_micros":“1230219000000000”,
"recording_wav":"https://app.ringostat.com/recordings/ua8_-11111111111.1111111.wav?token=462908f128343fc23862397ddd638953"
"roistatid":“666666”,
"useragent":“Mozilla/5.0 (Linux; Android 8.0.0; LND-L29 Build/HONORLND-L29; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/96.0.4664.45 Mobile Safari/537.36”
"project_id": "1000"
"duration_ms": "122"
}

Отправка оповещений по исходящим звонкам может стать одной из главных составляющих автоматизации рутинной работы менеджеров в crm-системе, а так же контроля их работы с пропущенными звонками.

Примеры обработки оповещений перед исходящим звонком

вызвать карточку контакта из crm-системы;
добавить данные о звонке в карточку контакта, в crm-системе;
создать сущность в crm-системе(задача / контакт / лид / сделка);
закрепить сущность за звонящим менеджером;
контроллировать исходящие звонки менеджеров;
контроллировать перезвон по пропущенным звонкам;

Перед звонком
После звонка

Параметры, доступные для передачи:

Имя параметра	Описание параметра
Номер звонящего	Логин и отображаемое имя SIP-аккаунта
Куда звонили	Номер, на который звонил менеджер
Тип	Тип звонка: Out
Google Analytics resource UUID	Идентификатор отслеживания Google Analytics
Номер в формате E.164	Номер в формате E.164. Номера по E.164 могут иметь максимум 15 цифр и обычно записываются с префиксом «+».
ID звонка	Уникальный ID звонка в Ringostat
Дата звонка (микросекунды)	Дата звонка указанная в микросекундах
ID проекта	ID вашего проекта в сервисе Ringostat
Первый заполненный параметр	Первый заполненный параметр. Если вы выбираете два и более параметров, система отправит по вебхуку тот из них, который будет получен системой первым.

{
"caller":""Support PhonerLite" <supportringostat_example>",
"callee":"380441112233",
"type":"out",
"gaid":"UA-11111111-1",
"full_num":"+"Support PhonerLite" <supportringostat_example>"
"call_id":"3333333333.3333333",
"calldate_timestamp_micros":“1230219000000000”,
"recording_wav":"https://app.ringostat.com/recordings/ua8_-11111111111.1111111.wav?token=462908f128343fc23862397ddd638953"
}

Параметры, доступные для передачи:

Имя параметра	Описание параметра
Номер звонящего	Логин и отображаемое имя SIP-аккаунта
Куда звонили	Номер, на который звонил менеджер
Статус	Статус исходящего звонка
Дата	Дата и время звонка
Ценность	Ценность звонка, которую устанавливает менеджер во входящем звонке с этого номера
Длительность	Общее время разговора и ожидания ответа
Тип	Тип звонка: Out
Ожидание	Ожидание на линии до ответа
Разговор	Длительность разговора
Запись	Уникальный ID звонка в Ringostat
Google Analytics resource ID	Идентификатор отслеживания Google Analytics
Ссылка на аудиозапись (ogg)	Ссылка на аудиозапись разговора в формате ogg
Номер в формате E.164	Номер в формате E.164. Номера по E.164 могут иметь максимум 15 цифр и обычно записываются с префиксом «+».
ID звонка	Уникальный ID звонка в Ringostat
Есть запись	Параметр принимает значение 0 или 1 в зависимости от того, есть ли запись звонка
Карточка звонка	Ссылка на карточку звонка номера, с которого или на который был совершён звонок
Ответственные менеджеры	Список ID сотрудников, участвующих в распределении нагрузки по звонкам
Сотрудник	ФИО сотрудника, который обработал звонок
Отдел	Название отдела, в котором находится сотрудник, который обработал звонок
Целевой	Параметр принимает значение 0 или 1 в зависимости от того был ли звонок целевым
Повторный	Параметр принимает значение 0 или 1 в зависимости от того был ли звонок повторным
ID проекта	ID вашего проекта в сервисе Ringostat
Код сотрудника	ID сотрудника вашего проекта
Исходящий номер	Номер, который отобразился клиенту при исходящем звонке от менеджера
Дата звонка (микросекунды)	Дата звонка указанная в микросекундах
Длительность в миллисекундах	Длительность звонка в миллисекундах
Ссылка на аудиозапись (wav)	Ссылка на аудиозапись в wav формате
Первый заполненный параметр	Первый заполненный параметр. Если вы выбираете два и более параметров, система отправит по вебхуку тот из них, который будет получен системой первым.

Типы значений параметра “Статус звонка”:

Тип значения	Статус в журнале звонков	Описание
ANSWERED	Отвечен	не целевой звонок, на который ответил менеджер
BUSY	Занято	направления, на которые производилась переадресация, были заняты
FAILED	С ошибками	присваивается звонкам в том случае, если при переадресации был сбой от оператора связи или сип-аккаунты, что указаны в схеме переадресации, находились оффлайн во время звонка
CLIENT NO ANSWER	Нет ответа клиента	присваивается звонкам в том случае, если клиент заказал на сайте обратный звонок и не ответил на него/сбросил.
FAILED FORBIDDEN DESTINATION	Запрещенное направление	присваивается звонкам с виджета Callback, если была попытка звонка на закрытое направление (например в проекте разрешены звонки только по Казахстану, а звонок был в США)

{
"caller":""Support PhonerLite" <supportringostat_example>",
"callee":"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.33...
"full_num":"+"Support PhonerLite" <supportringostat_example>",
"call_id":"3333333333.3333333"
"has_recording":"0"
"call_card":"https://app.ringostat.com/project/callcards/card/....
"manager":"4411;4416;4421;5364;5909;6164",
"employee_fio":"Иван Иванов",
"department":"Отдел продаж",
"proper_flag":"1",
"repeated_flag":"0",
"project_id": “0000”,
"staffid":"1111",
"outbound_number":"380671234567",
"calldate_timestamp_micros":“1230219000000000”,
"recording_wav":"https://app.ringostat.com/recordings/ua8_-11111111111.1111111.wav?token=462908f128343fc23862397ddd638953"
}