Перечень используемых Вебхуков (Webhooks): различия между версиями
(Отмена правки 6621, сделанной A.buloichyk (обсуждение)) (Метка: отмена) |
(→Входящие параметры) |
||
Строка 173: | Строка 173: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
+ | ! scope="col" style="width:20px;"| № | ||
! scope="col"| Параметр | ! scope="col"| Параметр | ||
− | |||
! scope="col"| Описание | ! scope="col"| Описание | ||
+ | ! scope="col"| Как обрабатывается ссылка скриптом с указанным параметром, если он не указан | ||
|- | |- | ||
− | | | + | | 1 |
− | | | + | | CallId |
+ | | Идентификатор звонка | ||
+ | | Генерируется | ||
+ | |- | ||
+ | | 2 | ||
+ | | CallDate | ||
+ | | Дата звонка | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 3 | ||
+ | | CallerNumber | ||
| Номер телефона, с которого идет звонок | | Номер телефона, с которого идет звонок | ||
+ | | Ищет параметр phone, если не находит, то передается пустым | ||
+ | |- | ||
+ | | 4 | ||
+ | | CalledNumber | ||
+ | | Номер телефона, на который звонят при исходящем звонке | ||
+ | | - | ||
+ | |- | ||
+ | | 5 | ||
+ | | AnswerWaitTime | ||
+ | | Время ожидания ответа | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 6 | ||
+ | | ReasonCallLoss | ||
+ | | Причина потери звонка | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 7 | ||
+ | | MissedCall | ||
+ | | Признак пропущенного звонка | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 8 | ||
+ | | Outcoming | ||
+ | | Признак исходящего звонка | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 9 | ||
+ | | ContactInfo | ||
+ | | Наименование контрагента | ||
+ | | Ищет параметр name, если не находит, то передается пустым | ||
+ | |- | ||
+ | | 10 | ||
+ | | FirstCalledNumber | ||
+ | | Городской номер | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 11 | ||
+ | | FromWeb | ||
+ | | Признак заявки с сайта | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 12 | ||
+ | | WebPage | ||
+ | | Страница, с которой пришла заявка с сайта | ||
+ | | Ищет параметр domain, если не находит, то передается пустым | ||
+ | |- | ||
+ | | 13 | ||
+ | | Comment | ||
+ | | Комментарий, что подтянется в задачу | ||
+ | | Ищет параметр comment, если не находит, то пустой | ||
+ | |- | ||
+ | | 14 | ||
+ | | Object1CId | ||
+ | | Id объекта 1С, что передается вместе с событием (используется для исходящих) | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 15 | ||
+ | | Object1CType | ||
+ | | Тип объекта 1С, что передается вместе с событием (используется для исходящих) | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 16 | ||
+ | | CarModel | ||
+ | | Модель автомобиля | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 17 | ||
+ | | Email | ||
+ | | Электронная почта | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 18 | ||
+ | | PhoneStation | ||
+ | | Передает 'AS' | ||
+ | | Код телефонной станции | ||
+ | |- | ||
+ | | 19 | ||
+ | | AdvChannel | ||
+ | | Рекламный канал | ||
+ | | Ищет advchannel, если не находит, то передается пустым | ||
+ | |||
+ | |- | ||
+ | | 20 | ||
+ | | session_id | ||
+ | | Параметр для динамического коллтрэкинга | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 21 | ||
+ | | user_id | ||
+ | | Параметр для динамического коллтрэкинга | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 22 | ||
+ | | X_ROISTAT | ||
+ | | UTM-метка | ||
+ | | Ищет x-roistat, если не находит, то передается пустым | ||
+ | |- | ||
+ | | 23 | ||
+ | | X_ROISTAT_PHONE | ||
+ | | UTM-метка | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 24 | ||
+ | | X_ROISTAT_MARKER | ||
+ | | UTM-метка | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 25 | ||
+ | | Duration | ||
+ | | Длительность звонка | ||
+ | | Передается пустым | ||
+ | |- | ||
+ | | 26 | ||
+ | | Parts | ||
+ | | | ||
+ | | если не указан, то <?xml version="1.0" encoding="UTF-8"?><data>, | ||
+ | если session_id и user_id заполнены, то | ||
+ | <object type="string" name="session_id">'.$session_id.'</object>'.'<object type="string" name="user_id">'.$user_id.'</object> | ||
+ | если WebPage заполнено и равно JivoSite, то | ||
+ | <object type="string" name="ВидОбращения">Чат</object> | ||
+ | если Duration заполнено, то <object type="string" name="Duration">'.$Duration.'</object>' | ||
+ | Если $x_roistat заполнено, то | ||
+ | <object type="string" name="x-roistat">'.$x_roistat.'</object> | ||
+ | <object type="string" name="x-roistat-phone">'.$x_roistat_phone.'</object> | ||
+ | <object type="string" name="x-roistat-marker">'.$x_roistat_marker.'</object></datа> | ||
+ | |||
+ | Если указан, то декодируем, добавляем строки перед </datа> | ||
+ | <object type="string" name="session_id">'.$session_id.'</object> | ||
+ | <object type="string" name="user_id">'.$user_id.'</object> | ||
+ | |||
+ | <object type="string" name="Duration">'.$Duration.'</object> | ||
|- | |- | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Версия 10:17, 20 июля 2021
Статья в разработке
Содержание
Введение
В статье представлено описание всех Вебхуков (Webhooks) и методов, которые используются для организации взаимодействия программы с внешними системами: телефония, сайт, мобильное приложение, мессенджеры и т.д.
Перечень Вебхуков (Webhooks)
crm_reg_call.php
Описание
Регистрирует события в программе: звонок (входящий, исходящий, пропущенный), заявка с сайта.
Входящие параметры
Параметр | Тип | Описание |
---|---|---|
CallId | Идентификатор звонка | |
CallerNumber | Номер телефона, на который идет звонок | |
CallDate | Дата звонка | |
AnswerWaitTime | Время ожидания ответа | |
AnswerWaitTime | Время ожидания ответа | |
ReasonCallLoss | Причина потери звонка | |
CalledNumber | Номер телефона, на который звонят при исходящем звонке | |
ContactInfo | ||
Comment | ||
MissedCall | bool | Признак пропущенного звонка |
Outcoming | bool | Признак исходящего звонка |
FirstCalledNumber | ||
FromWeb | bool | Признак заявки с сайта |
WebPage | string | Страница, с которой пришла заявка с сайта |
Object1CId | ||
Object1CType | ||
CarModel | ||
PhoneStation | ||
PhoneStation | ||
session_id | ||
Parts |
getcallerdata.php
Описание
Возвращает имя клиента, который отображается на экране телефона.
Входящие параметры
Параметр | Тип | Описание |
---|---|---|
CallId | Идентификатор звонка | |
CallerNumber | Номер телефона, с которого идет звонок | |
ParsedCallerNumber |
getcalltype.php
Описание
Возвращает тип звонка согласно умной маршрутизации (см. шаги 3,4,5,6 в Умная машрутизация входящего звонка).
Входящие параметры
Параметр | Тип | Описание |
---|---|---|
CallerNumber | Номер телефона, с которого идет звонок |
getcurrenttime.php
Описание
Возвращает время на сервере 1С
/messenger/webhook_telegram
Описание
Регистрирует входящие сообщения из Telegram в программе
/messenger/webhook_whatsapp
Регистрирует входящие сообщения из WhatsApp в программе
/crm/callback.php
Описание
При поступлении заявки с сайта связывает клиента с менеджером по телефону.
Для настройки интеграции сайта и CRM-модуля при отправке форм с сайта необходимо вызывать Webhook следующего формата: http://<IP-адрес>/crm/callback.php?[params], где:
- <IP-адрес> - IP-адрес сервера телефонии, с которым интегрирована программа "Управление автоцентром".
- [params] - параметры http-запроса (см. Входящие параметры).
Пример в декодированном: http://11.11.11.11:555/crm/callback.php?phone=74955404614&startparam2=Андрей&startparam3=сообщение&domain=code_site&advchannel=Google
Входящие параметры
№ | Параметр | Описание | Как обрабатывается ссылка скриптом с указанным параметром, если он не указан |
---|---|---|---|
1 | CallId | Идентификатор звонка | Генерируется |
2 | CallDate | Дата звонка | Передается пустым |
3 | CallerNumber | Номер телефона, с которого идет звонок | Ищет параметр phone, если не находит, то передается пустым |
4 | CalledNumber | Номер телефона, на который звонят при исходящем звонке | - |
5 | AnswerWaitTime | Время ожидания ответа | Передается пустым |
6 | ReasonCallLoss | Причина потери звонка | Передается пустым |
7 | MissedCall | Признак пропущенного звонка | Передается пустым |
8 | Outcoming | Признак исходящего звонка | Передается пустым |
9 | ContactInfo | Наименование контрагента | Ищет параметр name, если не находит, то передается пустым |
10 | FirstCalledNumber | Городской номер | Передается пустым |
11 | FromWeb | Признак заявки с сайта | Передается пустым |
12 | WebPage | Страница, с которой пришла заявка с сайта | Ищет параметр domain, если не находит, то передается пустым |
13 | Comment | Комментарий, что подтянется в задачу | Ищет параметр comment, если не находит, то пустой |
14 | Object1CId | Id объекта 1С, что передается вместе с событием (используется для исходящих) | Передается пустым |
15 | Object1CType | Тип объекта 1С, что передается вместе с событием (используется для исходящих) | Передается пустым |
16 | CarModel | Модель автомобиля | Передается пустым |
17 | Электронная почта | Передается пустым | |
18 | PhoneStation | Передает 'AS' | Код телефонной станции |
19 | AdvChannel | Рекламный канал | Ищет advchannel, если не находит, то передается пустым |
20 | session_id | Параметр для динамического коллтрэкинга | Передается пустым |
21 | user_id | Параметр для динамического коллтрэкинга | Передается пустым |
22 | X_ROISTAT | UTM-метка | Ищет x-roistat, если не находит, то передается пустым |
23 | X_ROISTAT_PHONE | UTM-метка | Передается пустым |
24 | X_ROISTAT_MARKER | UTM-метка | Передается пустым |
25 | Duration | Длительность звонка | Передается пустым |
26 | Parts | если не указан, то <?xml version="1.0" encoding="UTF-8"?>,
если session_id и user_id заполнены, то <object type="string" name="session_id">'.$session_id.'</object>'.'<object type="string" name="user_id">'.$user_id.'</object> если WebPage заполнено и равно JivoSite, то <object type="string" name="ВидОбращения">Чат</object> если Duration заполнено, то <object type="string" name="Duration">'.$Duration.'</object>' Если $x_roistat заполнено, то <object type="string" name="x-roistat">'.$x_roistat.'</object> <object type="string" name="x-roistat-phone">'.$x_roistat_phone.'</object> <object type="string" name="x-roistat-marker">'.$x_roistat_marker.'</object></datа> Если указан, то декодируем, добавляем строки перед </datа> <object type="string" name="session_id">'.$session_id.'</object> <object type="string" name="user_id">'.$user_id.'</object> <object type="string" name="Duration">'.$Duration.'</object> |
/jivosite/jivosite.php
Описание
Регистрирует сообщения с чата Jivosite, интегрированного на сайте для взаимодействия с клиентами
Входящие параметры
Параметр | Тип | Описание |
---|---|---|
source | Код рекламного канала |