When Creating a Dialog OnImConnectorDialogStart

Scope: imconnector

Who can subscribe: any user

The event triggers when a dialog is created.

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

What the Handler Receives

Data is sent as a POST request

[
            'event' => 'ONIMCONNECTORDIALOGSTART',
            'eventId' => 1,
            'data' => [
                'CONNECTOR' => 'newcustomconnector',
                'LINE' => '105',
                'DATA' => [
                    [
                        'connector' => [
                            'connector_id' => 'newcustomconnector',
                            'line_id' => 105,
                            'chat_id' => 8,
                            'user_id' => 0,
                        ],
                        'session' => [
                            'id' => 3282,
                            'closed' => N,
                            'parent_id' => 0,
                            'close_term' => 10,
                        ],
                        'chat' => [
                            'id' => 8
                        ],
                        'user' => [
                            'id' => 0
                        ],
                    ],
                ],
            ],
            'ts' => 1714649632,
            'auth' => [
                'access_token' => 's6p6eclrvim6da22ft9ch94ekreb52lv',
                'expires_in' => 3600,
                'scope' => 'imconnector',
                '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

CONNECTOR*
string

Connector identifier

LINE*
integer

Open line identifier

DATA*
object

Object with dialog data

Parameter DATA

Required parameters are marked with *

Name
type

Description

connector*
object

Object with information about additional settings:

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

session*
object

Object with information about the session:

  • id — session identifier
  • closed — mark indicating if the dialog is closed. N — dialog is open
  • parent_id — identifier of the previous session
  • close_term — number of minutes until the session closes

chat*
object

Object with information about the chat:

  • id — chat identifier

user*
object

Object with information about the user:

  • id — user identifier in the external system

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 Sending Messages
Next
When Messages Are Updated