Skip to content

Latest commit

 

History

History
129 lines (113 loc) · 4.84 KB

on-open-line-message-add.md

File metadata and controls

129 lines (113 loc) · 4.84 KB
Raw

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

Scope: imopenlines

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

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

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

Данные передаются в виде 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.bitrix.info/rest/'',
        'status' => 'F',
        'client_endpoint' => 'https://some-domain.bitrix24.com/rest/'',
        'member_id' => 'a223c6b3710f85df22e9377d6c4f7553',
        'refresh_token' => '4s386p3q0tr8dy89xvmt96234v3dljg8',
        'application_token' => '51856fefc120afa4b628cc82d3935cce',
    ],
]

Параметры

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || event* string | Символьный код события || || eventId* integer | Идентификатор события || || data* object | Объект с данными события || || ts* integer | timestamp отправки события из очереди событий || || auth* object | Объект с параметрами авторизации и данными о портале, на котором произошло событие || |#

Параметр data {#data}

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || DATA* object | Объект с данными чата || |#

Параметр DATA {#chat-params}

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || connector* object | Объект с информацией о коннекторе:

  • connector_id — идентификатор коннектора
  • line_id — идентификатор открытой линии
  • chat_id — идентификатор чата
  • user_id — идентификатор пользователя во внешней системе || || chat* object | Объект с информацией о чате:
  • id — идентификатор чата || || message* object | Объект с информацией о сообщении:
  • id — идентификатор сообщения
  • date — дата и время добавления
  • text — текст сообщения
  • files — файлы
  • attach — прикрепленные файлы
  • system — отметка, что сообщения вляется системным. Имеет значение Y, если системное
  • user_id — идентификатор пользователя || || ref* object | Код трекера trackId для привязки сообщения к объекту CRM || || extra* object | Объект дополнительной информацией:
  • EXTRA_URL — внешняя ссылка для Bitrix24.Network || |#

Параметр auth

{% include notitle Параметр auth %}