Событие запроса обратного звонка ONEXTERNALCALLBACKSTART

Scope: telephony

Кто может подписаться: любой пользователь

Событие ONEXTERNALCALLBACKSTART срабатывает, когда посетитель заполняет CRM-форму обратного звонка. В настройках формы должно быть выбрано ваше приложение как линия для обратного звонка.

События не будут отправляться в приложение, пока установка не завершена. Проверьте установку приложения

Что получает обработчик

Данные передаются в виде POST-запроса

{
            "event": "ONEXTERNALCALLBACKSTART",
            "event_handler_id": "1053",
            "data": {
                "PHONE_NUMBER": "+74951234567",
                "TEXT": "Заказан обратный звонок с сайта, соединяю вас с клиентом",
                "VOICE": "ruinternalfemale",
                "CRM_ENTITY_TYPE": "CONTACT",
                "CRM_ENTITY_ID": "5785",
                "LINE_NUMBER": "7"
            },
            "ts": "1773234727",
            "auth": {
                "access_token": "s7p6eclrvim9da28dt9ch94ekreb52sv",
                "expires_in": "3600",
                "scope": "telephony",
                "domain": "some-domain.bitrix24.ru",
                "server_endpoint": "https://oauth.bitrix.info/rest/",
                "status": "F",
                "client_endpoint": "https://example.bitrix24.ru/rest/",
                "member_id": "a223c6b9410f85df78e9377d6c4f7213",
                "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
                "application_token": "51610fefc120afg4b628cc82d6298cce"
            }
        }

Параметр
тип

Описание

event
string

Символьный код события.

В данном случае — ONEXTERNALCALLBACKSTART

event_handler_id
integer

Идентификатор обработчика события

data
object

Объект с данными события.

Структура описана ниже

ts
timestamp

Дата и время отправки события из очереди событий

auth
object

Объект с параметрами авторизации пользователя, от имени которого сработало событие.

Структура описана ниже

Параметр data

Параметр
тип

Описание

PHONE_NUMBER
string

Номер телефона, на который нужно выполнить обратный звонок

TEXT
string

Текст, который должен быть произнесен ответственному перед началом звонка

VOICE
string

Идентификатор голоса для синтеза речи

CRM_ENTITY_TYPE
string

Тип связанного объекта CRM

CRM_ENTITY_ID
integer

Идентификатор объекта CRM, тип которого указан в CRM_ENTITY_TYPE

LINE_NUMBER
string

Номер внешней линии, через которую запрошен обратный звонок

Параметр auth

Обязательные параметры отмечены *

Название
тип

Описание

access_token
string

Токен авторизации OAuth 2.0

expires_in
integer

Время в секундах до истечения срока действия токена

scope*
string

Скоуп, в рамках которого произошло событие

domain*
string

Адрес Битрикс24, на котором произошло событие

server_endpoint*
string

Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2.0

status*
string

Статус приложения, подписавшегося на это событие:

client_endpoint*
string

Общий путь для вызовов методов REST API для Битрикс24, на котором произошло событие

member_id*
string

Идентификатор Битрикс24, на котором произошло событие

refresh_token
string

Токен продления авторизации OAuth 2.0

application_token*
string

Токен для безопасной обработки событий

Токены авторизации не всегда передаются в обработчик события. Если хит, инициировавший событие, не удалось привязать к конкретному пользователю Битрикс24, токены не передаются. Обязательно проверяйте содержимое ключа auth в коде.

Рекомендуем хранить токены, полученные ранее при установке приложения. Используйте их при работе с интерфейсом приложения в виде встроек, виджетов и так далее.

Продолжите изучение

Предыдущая
При нажатии на телефонный номер
Следующая
Использование SIP и встроенной телефонии