Open Channels

Bitrix24 Open Channels receive client inquiries from messengers and social networks and route them to operators. The methods in this section configure channels, run dialogs on behalf of an operator, link dialogs to CRM cards, and read contact-center statistics.

Scope: imopenlines | Base URL: https://vibecode.bitrix24.com/v1 | Authorization: X-Api-Key

Quick start | Full example | Endpoint reference | Error codes

Documentation sections

• Open Channel configurations — create, read, update, delete and search channels, plus accepting and finishing a dialog as an operator
• Open Channel quick replies — channel reply templates: list, create, update, delete
• Open Channel sessions — session search, session metrics, reassignments and correspondence, opening a client chat, starting a session, intercepting a dialog and joining a dialog
• Chats by CRM card — channel dialogs linked to a lead, deal, company or contact
• CRM chat actions — add an employee to a CRM chat and remove them, message the client, create a lead from an inquiry
• Dialog metadata — the dialog card and channel ID by chatId, dialogId or sessionId
• Session history — the correspondence of the chat's latest session in a single response
• Operator actions and my pause — skip, transfer, mark the client as spam, finish another operator's dialog, manage your own operator pause
• Channel aggregates for a period — channel summary metrics for a monitoring dashboard
• Operators (real-time) — operator status and load
• Ratings (CSAT) — sessions with a client rating for a period

Identifiers

Dialog actions run on behalf of the employee the key is bound to. They have no "employee" parameter — details in Operator actions and my pause.

Statistics (dashboard)

The statistics methods ship in the imopenlines 26.700.0 update and are not yet available on all Bitrix24 accounts. If the update has not reached your Bitrix24 account yet, the API returns 422 METHOD_NOT_YET_AVAILABLE — a sign that the method is not yet released on the account, not an integration error.

Six methods only read data: channel summary metrics, real-time operators, sessions with filters, metrics of selected sessions, client ratings and reassignment history. Data is limited to the permissions of the employee the key is bound to. If that employee has no access to any channel, the method returns an empty list or zero metrics rather than an error. The methods require the Open Channels statistics permission report_open_lines; without it, the request returns 403 B24_TARIFF_RESTRICTION.

The other methods in the section work on any Bitrix24 account. The exception is Session history: the Vibecode platform enables it gradually, and until it is enabled the call returns 403 OPENLINES_HISTORY_DISABLED. Session history requires neither the report_open_lines permission nor the imopenlines 26.700.0 update.

Common scenarios

Recommendations

• Get summary metrics from POST /v1/openlines/stats — it computes them on the Bitrix24 side. Collecting the same figures by paging through POST /v1/openlines/sessions/search consumes the request limit.
• The polling frequency for summary metrics and real-time operators is given on the Channel aggregates for a period and Operators (real-time) pages.

Quick start

Get a channel ID and that channel's summary metrics for a period.

1. Find the channel

curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://vibecode.bitrix24.com/v1/openline-configs"

In the response, data is the array of channels on the Bitrix24 account. The data[].id field is the channel ID, data[].name is its name.

2. Request the channel's summary metrics

curl -X POST "https://vibecode.bitrix24.com/v1/openlines/stats" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "dateFrom": "2026-09-01T00:00:00+00:00",
    "dateTo": "2026-09-30T23:59:59+00:00",
    "configId": 3
  }'

Response:

{
  "success": true,
  "data": {
    "totalSessions": 3,
    "closedSessions": 2,
    "spamSessions": 0,
    "avgWaitAnswer": 25,
    "avgSessionDuration": 17.3333,
    "likeCount": 0,
    "dislikeCount": 0,
    "votedSessions": 0,
    "positiveRate": 0,
    "kpiFirstAnswerOk": 0,
    "kpiFirstAnswerFail": 0,
    "sessionsBySource": [{ "source": "livechat", "count": 2 }, { "source": "telegrambot", "count": 1 }],
    "sessionsByHour": [1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0],
    "sessionsByOperator": [{ "operatorId": 42, "count": 2, "avgWaitAnswer": 25, "positiveRate": 0 }]
  }
}

Response fields are on the Channel aggregates for a period page.

Full example

A report on a channel's inquiries for a period: summary metrics, sessions linked to CRM, their metrics, and all dialogs of the first session's CRM card. All calls only read data.

const VIBE_KEY = process.env.VIBE_KEY
const BASE = 'https://vibecode.bitrix24.com/v1'

async function api(method, path, body = null) {
  const opts = { method, headers: { 'X-Api-Key': VIBE_KEY } }
  if (body) {
    opts.headers['Content-Type'] = 'application/json'
    opts.body = JSON.stringify(body)
  }
  const res = await fetch(`${BASE}${path}`, opts)
  return res.json()
}

// 1. Channels on the account: take the ID of the first channel
const lines = await api('GET', '/openline-configs')
const configId = lines.data[0].id
console.log('Channel:', configId)

// 2. Channel summary metrics for the period
const period = { dateFrom: '2026-10-01T00:00:00+00:00', dateTo: '2026-10-19T23:59:59+00:00' }
const stats = await api('POST', '/openlines/stats', { ...period, configId })
console.log('Inquiries:', stats.data.totalSessions, 'closed:', stats.data.closedSessions)

// 3. Sessions of the same period linked to CRM
const found = await api('POST', '/openlines/sessions/search', {
  configId,
  dateCreateFrom: period.dateFrom,
  dateCreateTo: period.dateTo,
  hasCrm: 'Y',
  limit: 50,
})
const sessions = found.data.sessions
console.log('Sessions on page:', sessions.length, 'more:', found.data.hasNextPage)

if (sessions.length > 0) {
  // 4. Metrics of the sessions found, up to 100 per call
  const metrics = await api('POST', '/openlines/sessions/stats', {
    sessionId: sessions.map((s) => s.id),
  })
  for (const m of metrics.data.sessions) console.log('Session', m.sessionId, 'messages:', m.messagesCount)

  // 5. All dialogs of the CRM card the first session is linked to
  const { crmEntityType, crmEntityId } = sessions[0]
  const chats = await api('GET', `/openlines/crm/chats?crmEntityType=${crmEntityType}&crmEntityId=${crmEntityId}&activeOnly=false`)
  for (const c of chats.data) console.log('Chat', c.chatId, 'channel:', c.connectorTitle)
}

How to get the next pages of sessions is described in the "Pagination" paragraph on the Session search page. The chatId found in step 5 is accepted by dialog interception, joining a dialog and a message to the client.

Endpoint reference

All 38 endpoints in the section:

Accepting and finishing a dialog as an operator are described on the Open Channel configurations page. The six statistics methods ship in the imopenlines 26.700.0 update, see Statistics (dashboard). GET /v1/openline-configs/fields makes no Bitrix24 call — Vibecode returns the field schema itself.

Error codes

Open Channels errors

When Bitrix24 rejects a request, the response comes as 422 BITRIX_ERROR, and the Bitrix24 code is duplicated in the error.b24Code field:

The codes of a specific method are in the ## Errors table on its page.

System errors

Common codes (SCOPE_DENIED, TOKEN_MISSING, WRITE_BLOCKED_READONLY_KEY, RATE_LIMITED and others) are on the API errors page.

See also

• Open Channel bot
• Chats and messages
• API changelog