Open Channels Connectors: Overview of Methods

Open Channels Connectors are a tool for integrating external messengers and social networks with Bitrix24. Connectors allow you to:

  • Respond to customer messages from various channels within a single interface.
  • Connect chatbots to automate communication with customers.
  • Analyze dialogue statistics to assess the effectiveness of communications.

Quick navigation: all methods
User documentation: Connecting Contact Center Channels

Connector Interaction with Other Objects

Open Channels. They collect messages from connectors, manage queues, and distribute messages among employees. Working with open channels should be done using the group of methods imopenlines.*.

CRM. Based on messages, leads and deals can be automatically created using the methods crm.lead.add and crm.deal.add.

User. The user ID can be obtained using the methods user.get and user.search.

Chat. The methods im.chat.* and im.message.* are responsible for the correspondence with users.

Chatbots. The setup of automatic responses and chatbots is performed using the methods imbot.*.

How to Connect a Connector

  1. Register the connector using the method imconnector.register.
  2. Activate it using the method imconnector.activate.
  3. Set the connector data using the method imconnector.connector.data.set.
  4. Check the connector status using the method imconnector.status and ensure it is ready for operation.

How to Work with Messages

You can send a message using the method imconnector.send.messages.

Sent messages can be modified using the method imconnector.update.messages. This method changes the parameters of the user, message, and chat.

Messages from open channels can be deleted using the method imconnector.delete.messages.

How to Add a Widget to the Contact Center

To add the connector widget to the Contact Center, use the widget code CONTACT_CENTER. This code must be specified in the PLACEMENT parameter of the method placement.bind.

Overview of Methods and Events

Scope: imopenlines
Who can execute the method: any user

The imconnector.* methods in the current version do not support operation via webhooks.

Connector

Method

Description

imconnector.register

Register a connector

imconnector.activate

Activate a connector

imconnector.status

Get the connector status

imconnector.connector.data.set

Change connector settings

imconnector.list

Get a list of connectors

imconnector.unregister

Unregister a connector

Event

Triggered

OnImConnectorLineDelete

When an open line is deleted

OnImConnectorStatusDelete

When an open line is disabled

Chats and Messages

Method

Description

imconnector.send.messages

Send messages to Bitrix24

imconnector.update.messages

Modify sent messages

imconnector.delete.messages

Delete sent messages

imconnector.send.status.delivery

Update delivery status to delivered

imconnector.chat.name.set

Set a new chat name

Event

Triggered

OnImConnectorDialogStart

When a dialog is created

OnImConnectorDialogFinish

When a dialog is closed

OnImConnectorMessageAdd

When a new message is added

OnImConnectorMessageDelete

When messages are deleted

OnImConnectorMessageUpdate

When messages are updated

Continue Learning