When Adding a Message to the Chat OnOpenLineMessageAdd

Scope: imopenlines

Who can subscribe: any user

The OnOpenLineMessageAdd event is triggered when a message is added to the open line chat.

Subscribe to the event can only be done through the application. Only those events intended for the connector added by the application can be received in the handler.

Events will not be sent to the application until the installation is complete. Check the application installation

What the Handler Receives

Data is transmitted in the form of a POST request

[
            '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',
            ],
        ]

Parameters

Required parameters are marked with *

Name
type

Description

event*
string

Symbolic event code

eventId*
integer

Event identifier

data*
object

Object with event data

ts*
integer

Timestamp of the event sent from the event queue

auth*
object

Object with authorization parameters and information about the account where the event occurred

Parameter data

Required parameters are marked with *

Name
type

Description

DATA*
object

Object with chat data

Parameter DATA

Required parameters are marked with *

Name
type

Description

connector*
object

Object with information about the connector:

  • connector_id — connector identifier
  • line_id — open line identifier
  • chat_id — chat identifier
  • user_id — user identifier in the external system

chat*
object

Object with information about the chat:

  • id — chat identifier

message*
object

Object with information about the message:

  • id — message identifier
  • date — date and time of addition
  • text — message text
  • files — files
  • attach — attached files
  • system — flag indicating whether the message is system. It has the value Y if it is system
  • user_id — user identifier

ref*
object

Tracker code trackId for linking the message to a CRM object

extra*
object

Object with additional information:

  • EXTRA_URL — external link for Bitrix24.Network

Parameter auth

Required parameters are marked with *

Name
type

Description

access_token
string

Authorization token OAuth 2.0

expires_in
integer

Time in seconds until the token expires

scope*
string

Scope under which the event occurred

domain*
string

Address of Bitrix24 where the event occurred

server_endpoint*
string

Address of the Bitrix24 authorization server needed to refresh OAuth 2.0 tokens

status*
string

Status of the application that subscribed to this event:

client_endpoint*
string

Common path for REST API method calls for Bitrix24 where the event occurred

member_id*
string

Identifier of Bitrix24 where the event occurred

refresh_token
string

Token for extending authorization OAuth 2.0

application_token*
string

Token for secure event handling

Authorization tokens are not always passed to the event handler. If the hit that initiated the event could not be linked to a specific Bitrix24 user, the tokens are not passed. Always check the contents of the auth key in the code.

It is recommended to store tokens obtained earlier during the application installation. Use them when working with the application interface in the form of embeds, widgets, and so on.

Previous
When Creating a Chat
Next
When Updating a Message