Webhooks
Веб-хук (webhook) — это отправка запросов по событиям звонков пришедших в коллтрекинг AlloStat. Они позволяют получать уведомления о звонках в реальном времени, дополняя их информацией коллтрекинга (источник, канал, кампания, ключевое слово, Google Analytics cid, clientID Яндекс Метрики и т.д.). Используются для уведомления сторонних сервисов об изменениях на странице Звонки. Webhooks отправляют информацию на указанный вами URL, но при этом не ожидают ответа. Вы должны самостоятельно реализовать его прием и "обработку".
Подключение
- Для подключения веб-хуков коллтрекинга необходимо указать адрес URL, куда будут отправляться POST-запросы. Указать можно как страницу https, так и http
(сертификат сервера не должен быть самоподписанным, если это https).
Для этого в личном кабинете AlloStat перейдите в «Настройки», в пункте «Веб-хуки» введите URL и нажмите «Сохранить».
- На момент нажатия кнопки «Сохранить» URL должен быть доступен и быть рабочим, так как при этом на него посылается пустой запрос POST.
- В случае, если в ответ не приходит статус 200, URL считается недействительным и выдаётся сообщение об ошибке:
Это сообщение может появляться также в случае возникновения сетевых неполадок
(не зависящих от AlloStat) между коллтрекингом и вашим сервером обработки веб-хуков.
Пример webhook
Пример данных, которые передаются в webhook по окончании каждого звонка.
{
"call_date_time":"2019-02-20 11:44:11",
"call_date_time_epoch":"15585165181",
"caller_id":"74951234567",
"call_id":"74957654321",
"secondary":0,
"answered":1,
"duration":910,
"ga_client_id":"68766244.1515760733",
"ya_client_id":"1515765912247738604",
"url":"http://www.site.com?utm_source=facebook&utm_medium=cpc",
"source":"facebook",
"medium":"social ",
"campaign":"myCampaign",
"content":"myContent",
"term":"myTerm",
"roistatVisit":"123456"
}
Список переменных и описание
В случае отсутствия данных передается значение "null".
| Переменная | Пример значения | Описание переменной |
|---|---|---|
| call_date_time | 2019-02-20 11:44:11 | Время звонка |
| call_date_time_epoch | 15585165181 | Время звонка в формате Unix |
| caller_id | 74951234567 | Номер звонящего |
| call_id | 74957654321 | Номер на который звонили |
| secondary | 1 | 1-Повторный звонок (любой не первичный) 0-Первичный звонок |
| answered | 1 | 1-Звонок отвечен 0-Звонок не отвечен |
| duration | 910 | Длительность разговора |
| ga_client_id | 68766244.1515760733 | User Client Id (gid) для Google Analytics |
| ya_client_id | 1515765912247738604 | User Client Id для Яндекс Метрики |
| url | http://www.site.com ?utm_source=facebook &utm_medium=cpc | Адрес привязанного посещения |
| source | Значение utm_source (источник) | |
| medium | cpc | Значение utm_medium (канал) |
| campaign | myCampaign | Значение utm_campaign (кампания) |
| content | myContent | Значение utm_content (содержание) |
| term | myTerm | Значение utm_term (ключевое слово) |
| roistatVisit | 123456 | Значение куки roistat_visit (Идентификатор визита Roistat) |