Chats by CRM card

GET /v1/openlines/crm/chats · POST /v1/openlines/sessions/intercept · POST /v1/openlines/sessions/join

Three endpoints cover the CRM-card widget flow: find the Open Channel dialogs attached to a lead, deal, company or contact, then put the current operator into the dialog you found. All three require the imopenlines scope, are available on every Bitrix24 account and do not require the imopenlines 26.700.0 update.

The chatId from the first endpoint's response is passed to the second and third endpoints unchanged. The other source of the same identifier is the sessions[].chatId field in the Session list response.

Important: sessions/intercept and sessions/join write into a live conversation with a client: after the call the operator becomes a participant in the conversation. Permissions are checked by Bitrix24, and a Bitrix24 account administrator passes that check for any dialog on the account.

Chats of a CRM card

GET /v1/openlines/crm/chats

Request parameters (query)

Each parameter is passed exactly once and under a flat name: a repeat (crmEntityId=1&crmEntityId=2) and the bracket form (crmEntityId[]=1) are rejected with 400 INVALID_PARAMS rather than resolved in favor of one of the values.

Response fields

data is an array of rows. For an object with no Open Channel dialogs it is empty, and that is not an error. It is also empty when no object with that crmEntityId exists.

Example

curl "https://vibecode.bitrix24.com/v1/openlines/crm/chats?crmEntityType=lead&crmEntityId=1001213" \
  -H "X-Api-Key: YOUR_API_KEY"

{
  "success": true,
  "data": [
    { "chatId": 4531, "connectorId": "telegrambot", "connectorTitle": "Telegram" }
  ]
}

The same request with activeOnly=false for an object whose dialogs are already closed returns them in the same shape — for example { "chatId": 31, "connectorId": "network", "connectorTitle": "Bitrix24 Network" }.

Intercepting a dialog

POST /v1/openlines/sessions/intercept

Moves the dialog to the current operator: the previous operator is no longer in charge of this session.

curl -X POST "https://vibecode.bitrix24.com/v1/openlines/sessions/intercept" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "chatId": 4531 }'

Successful response: { "success": true, "data": { "chatId": 4531, "intercepted": true } }.

Joining a dialog

POST /v1/openlines/sessions/join

Adds the current operator to the dialog as one more participant, leaving the previous one in place.

curl -X POST "https://vibecode.bitrix24.com/v1/openlines/sessions/join" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "chatId": 4531 }'

Successful response: { "success": true, "data": { "chatId": 4531, "joined": true } }.

Both endpoints accept chatId as a number (4531) or as a string in the chat4531 form; in the response the identifier is always a number. The field name is chatId or CHAT_ID; dialogId is not accepted.

Errors

A misspelled crmEntityType is rejected before Bitrix24 is called — with 400 INVALID_PARAMS and the list of accepted values.

Full list of common API errors — Errors.

Known specifics

• Dialog closure is not checked. sessions/intercept and sessions/join succeed on a dialog whose session was closed long ago: the operator is added to the chat participants, the response is intercepted: true and joined: true. To work with open dialogs only, take chatId from crm/chats without activeOnly=false.
• A repeated join is not an error. sessions/join for an operator who already participates in the dialog answers joined: true again.
• The join is visible in the participant list. After join the operator appears among the participants of the Open Channel chat — that is the check that the call took effect.

See also

• Session list
• Dialog metadata
• Session history
• Open Channels