Событие начала исходящего звонка ONEXTERNALCALLSTART

Scope: telephony

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

Событие ONEXTERNALCALLSTART срабатывает, когда пользователь нажимает на телефонный номер в объектах CRM для совершения исходящего звонка через выбранное приложение телефонии.

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

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

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

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

{
            "event": "ONEXTERNALCALLSTART",
            "event_handler_id": "1055",
            "data": {
                "PHONE_NUMBER": "+74951234567",
                "PHONE_NUMBER_INTERNATIONAL": "+74951234567",
                "EXTENSION": "",
                "USER_ID": "1269",
                "CALL_LIST_ID": "0",
                "LINE_NUMBER": "7",
                "IS_MOBILE": "0",
                "CALL_ID": "externalCall.89350264e026dace3f2b14d1f438257c.1773236989",
                "CRM_ENTITY_TYPE": "CONTACT",
                "CRM_ENTITY_ID": "797"
            },
            "ts": "1773236988",
            "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

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

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

event_handler_id
integer

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

data
object

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

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

ts
timestamp

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

auth
object

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

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

Параметр data

Параметр
тип

Описание

PHONE_NUMBER
string

Номер телефона, по которому пользователь начал исходящий звонок

PHONE_NUMBER_INTERNATIONAL
string

Номер телефона в международном формате

EXTENSION
string

Добавочный номер

USER_ID
integer

Идентификатор пользователя, для которого нужно зарегистрировать внешний звонок

CALL_LIST_ID
integer

Идентификатор списка обзвона, если звонок начат из списка обзвона

LINE_NUMBER
string

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

IS_MOBILE
string

Флаг того, что звонок инициирован из мобильного приложения.

Возможные значения:

  • 0 - звонок инициирован не из мобильного приложения
  • 1 - звонок инициирован из мобильного приложения

CALL_ID
string

Идентификатор звонка, созданный при регистрации внешнего вызова

CRM_ENTITY_TYPE
string

Тип объекта CRM, из карточки которого начат звонок

CRM_ENTITY_ID
integer

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

Параметр 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 в коде.

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

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

Предыдущая
Обзор событий
Следующая
При заполнении CRM-формы