Open Channels

Bitrix24 Open Channels (the imopenlines module) — inbound inquiries from messengers and social networks, routing to operators, CRM integration, and service-quality ratings. The section covers two facets of the module: managing channel settings and the contact-center manager's dashboard statistics.

• Base URL: https://vibecode.bitrix24.com
• Authentication: the X-Api-Key header (personal key) or X-Api-Key + Authorization: Bearer (OAuth application)
• Key scope: imopenlines

Quick start | Full example | Endpoint reference | Error codes

What the section covers

Identifiers

Open Channel configuration

Managing Open Channel settings — create, list, get, update, delete, search. Generally available, no rollout required. Two operator actions on a dialog live here as well: accepting it for handling (answer) and finishing it (finish).

Full documentation: Open Channel configuration.

Statistics (dashboard)

The statistics methods are being rolled out — they ship in the imopenlines 26.700.0 update. They are not available on all Bitrix24 accounts yet. If the methods are not yet available on your Bitrix24 account, the API returns 422 METHOD_NOT_YET_AVAILABLE — this is not an integration error but a sign that the update has not reached the account yet.

A list of inquiries with metrics, real-time operator load, channel aggregates, customer ratings (CSAT), and transfer history. All methods are read-only. Data is scoped to the permissions of the user the key acts on behalf of: if that user has no access to any channel, the method returns an empty result (or zero aggregates) rather than an error. These methods require access to Open Channels statistics — the report_open_lines permission. Without it, a request returns 403 B24_TARIFF_RESTRICTION.

All six methods ship in the imopenlines 26.700.0 update. The Bitrix24 method names for cross-referencing with the Bitrix24 documentation are in the Endpoint reference.

Session correspondence

A standalone generally-available method (no rollout required): the transcript of a chat's latest Open Channel session by its identifier — messages, participants and file metadata in one response.

The endpoint is enabled gradually by the Vibecode platform: while it is off, the call answers 403 OPENLINES_HISTORY_DISABLED. The report_open_lines permission and the 26.700.0 update are NOT required for this method. Full documentation: Session history.

Common scenarios

Recommendations

• For summary metrics, use stats — it computes aggregates on the Bitrix24 side. Do not assemble the same figures with client-side aggregation over sessions/search: that runs into the Bitrix24 REST request limit.
• operators returns near-real-time data (status and the active-chat counter are read separately). For a monitoring widget, poll the method no more than once every 30 seconds.
• stats is a heavy method: request it no more than once every 30–60 seconds and cache the result on your side.
• Call statistics live on a separate endpoint — GET /v1/calls/statistics. Open Channels statistics use POST requests because they carry rich filters.

Quick start

Channel aggregates for June:

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-06-01T00:00:00+00:00",
    "dateTo": "2026-06-30T23:59:59+00:00",
    "configId": 3
  }'

{
  "success": true,
  "data": {
    "totalSessions": 340,
    "closedSessions": 318,
    "spamSessions": 4,
    "avgWaitAnswer": 42.7,
    "avgSessionDuration": 612.3,
    "likeCount": 210,
    "dislikeCount": 15,
    "votedSessions": 225,
    "positiveRate": 0.9333,
    "kpiFirstAnswerOk": 300,
    "kpiFirstAnswerFail": 18,
    "sessionsBySource": [{ "source": "livechat", "count": 200 }, { "source": "whatsapp", "count": 140 }],
    "sessionsByHour": [0,0,0,0,0,0,2,10,25,40,38,30,28,22,20,25,30,20,15,10,8,5,3,1],
    "sessionsByOperator": [{ "operatorId": 42, "count": 120, "avgWaitAnswer": 38.1, "positiveRate": 0.95 }]
  }
}

Full example

Report "inquiries for the month with a review of problem sessions":

1. POST /v1/openlines/stats with dateFrom/dateTo — summary metrics for the channel.
2. POST /v1/openlines/sessions/search with the same period and limit: 50 — the first page of the session list. Pagination: increase offset by limit while data.hasNextPage equals true.
3. POST /v1/openlines/sessions/stats with an array of sessionId (up to 100) — detailed metrics for the selected sessions.

For a stable page-by-page export, pin the upper bound of the period: set dateCreateTo to the moment the export starts. Without a fixed bound, new sessions arriving during paging shift the pages, and records at the boundaries may be duplicated or lost.

Endpoint reference

All 18 endpoints of the section:

Open Channel configuration and operator actions work on any Bitrix24 account. The six statistics methods ship in the imopenlines 26.700.0 update — until it reaches the account, they return 422, 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 the call, the response arrives as 422 BITRIX_ERROR, and the raw Bitrix24 code is duplicated in the error.b24Code field:

System errors

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

See also

• Open Channel configuration
• Chats and messages
• API changelog