При добавлении сообщения в чат OnOpenLineMessageAdd

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imopenlines

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

Событие OnOpenLineMessageAdd срабатывает при добавлении сообщения в чат открытой линии.

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

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

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

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

{
    "event": "ONOPENLINEMESSAGEADD",
    "eventId": 1,
    "data": {
        "DATA": [
            {
                "connector": {
                    "connector_id": "livechat",
                    "line_id": 128,
                    "chat_id": 10587,
                    "user_id": 1985
                },
                "chat": {
                    "id": 10585
                },
                "message": {
                    "id": 80964,
                    "date": "",
                    "text": "hello",
                    "files": [],
                    "attach": "",
                    "system": "N",
                    "user_id": 1985
                },
                "ref": [],
                "extra": {
                    "EXTRA_URL": ""
                }
            }
        ]
    },
    "ts": 1714649632,
    "auth": {
        "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
        "expires_in": 3600,
        "scope": "imopenlines",
        "domain": "some-domain.bitrix24.com",
        "server_endpoint": "https://oauth.bitrix24.tech/rest/",
        "status": "F",
        "client_endpoint": "https://some-domain.bitrix24.com/rest/",
        "member_id": "a223c6b3710f85df22e9377d6c4f7553",
        "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
        "application_token": "51856fefc120afa4b628cc82d3935cce"
    }
}

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

Параметр
тип

Описание

event*
string

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

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

eventId*
integer

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

data*
object

Объект, содержащий данные события.

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

ts*
timestamp

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

auth*
object

Объект, содержащий параметры авторизации и данные о портале, на котором произошло событие.

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

Параметр data

Параметр
тип

Описание

DATA*
array

Массив объектов с данными сообщения.

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

Элемент массива DATA

Каждый элемент массива DATA — объект со структурой:

Параметр
тип

Описание

connector*
object

Объект с информацией о коннекторе.

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

chat*
object

Объект с информацией о чате.

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

message*
object

Объект с информацией о сообщении.

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

ref*
array

Массив с кодом трекера trackId для привязки сообщения к объекту CRM. В примере передается пустым

extra*
object

Объект с дополнительной информацией.

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

Параметр
тип

Описание

connector_id*
string

Идентификатор коннектора

line_id*
integer

Идентификатор открытой линии

chat_id*
integer

Идентификатор чата

user_id*
integer

Идентификатор пользователя во внешней системе
Параметр chat

Параметр
тип

Описание

id*
integer

Идентификатор чата
Параметр message

Параметр
тип

Описание

id*
integer

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

date*
string

Дата и время добавления сообщения

text*
string

Текст сообщения

files*
array

Файлы сообщения

attach*
string

Прикрепленные данные

system*
string

Отметка, что сообщение является системным: Y — да, N — нет

user_id*
integer

Идентификатор пользователя
Параметр extra

Параметр
тип

Описание

EXTRA_URL*
string

Внешняя ссылка для Bitrix24.Network

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

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

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

Предыдущая
При создании сессии
Следующая
При изменении сообщения