How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitrix24 Open Lines API

The Open Lines API from Bitrix24 — 50 operation(s) for open lines.

Bitrix24 Open Lines API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Open Lines. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 50 operations across 50 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

50 operations 50 paths 3 schemas 50 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Bitrix24 Open Lines API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 50

Across 50 paths, the API surfaces 50 operations — 50 POST. Each is listed below with its method, path, parameters, and response codes.

Open Lines 50
POST
/imconnector.activate
Activate Connector imconnector.activate
imconnector_activate body → 2004XX
POST
/imconnector.chat.name.set
Set a New Chat Name imconnector.chat.name.set
imconnector_chat_name_set body → 2004XX
POST
/imconnector.connector.data.set
Set Connector Settings imconnector.connector.data.set
imconnector_connector_data_set body → 2004XX
POST
/imconnector.delete.messages
Delete Sent Messages imconnector.delete.messages
imconnector_delete_messages body → 2004XX
POST
/imconnector.list
Get the List of Connectors imconnector.list
imconnector_list body → 2004XX
POST
/imconnector.register
Register the Connector imconnector.register
imconnector_register body → 2004XX
POST
/imconnector.send.messages
Send Messages to Bitrix24 imconnector.send.messages
imconnector_send_messages body → 2004XX
POST
/imconnector.send.status.delivery
Update Status "Delivered" imconnector.send.status.delivery
imconnector_send_status_delivery body → 2004XX
POST
/imconnector.send.status.reading
Update Status to "Read" imconnector.send.status.reading
imconnector_send_status_reading body → 2004XX
POST
/imconnector.status
Get the Status of the Connector imconnector.status
imconnector_status body → 2004XX
POST
/imconnector.unregister
Unregister the Connector imconnector.unregister
imconnector_unregister body → 2004XX
POST
/imconnector.update.messages
Update Sent Messages with imconnector.update.messages
imconnector_update_messages body → 2004XX
POST
/imopenlines.bot.session.finish
Finish Dialog imopenlines.bot.session.finish
imopenlines_bot_session_finish body → 2004XX
POST
/imopenlines.bot.session.message.send
Send an Automatic Message in the imopenlines.bot.session.message.send Dialog
imopenlines_bot_session_message_send body → 2004XX
POST
/imopenlines.bot.session.operator
Switch Dialog to Free Operator imopenlines.bot.session.operator
imopenlines_bot_session_operator body → 2004XX
POST
/imopenlines.bot.session.transfer
Transfer a Dialogue to an Operator or Queue using imopenlines.bot.session.transfer
imopenlines_bot_session_transfer body → 2004XX
POST
/imopenlines.config.add
Add Open Channel imopenlines.config.add
imopenlines_config_add body → 2004XX
POST
/imopenlines.config.delete
Delete Open Channel imopenlines.config.delete
imopenlines_config_delete body → 2004XX
POST
/imopenlines.config.get
Get Open Line by ID imopenlines.config.get
imopenlines_config_get body → 2004XX
POST
/imopenlines.config.list.get
Get the List of Open Channels imopenlines.config.list.get
imopenlines_config_list_get body → 2004XX
POST
/imopenlines.config.path.get
Get Link to Public Page of Open Channels imopenlines.config.path.get
imopenlines_config_path_get body → 2004XX
POST
/imopenlines.config.update
Update Open Channel imopenlines.config.update
imopenlines_config_update body → 2004XX
POST
/imopenlines.crm.chat.get
Get Chats for CRM Object imopenlines.crm.chat.get
imopenlines_crm_chat_get body → 2004XX
POST
/imopenlines.crm.chat.getLastId
Get the Id of the Last Chat imopenlines.crm.chat.getLastId
imopenlines_crm_chat_getLastId body → 2004XX
POST
/imopenlines.crm.chat.user.add
Add User to Existing Chat imopenlines.crm.chat.user.add
imopenlines_crm_chat_user_add body → 2004XX
POST
/imopenlines.crm.chat.user.delete
Remove User from Chat imopenlines.crm.chat.user.delete
imopenlines_crm_chat_user_delete body → 2004XX
POST
/imopenlines.crm.lead.create
Create a Lead Based on the Dialogue imopenlines.crm.lead.create
imopenlines_crm_lead_create body → 2004XX
POST
/imopenlines.crm.message.add
Send a Message to Open Channel imopenlines.crm.message.add
imopenlines_crm_message_add body → 2004XX
POST
/imopenlines.dialog.get
Get Information About the Operator's Dialog imopenlines.dialog.get
imopenlines_dialog_get body → 2004XX
POST
/imopenlines.message.quick.save
Save Message as Quick Answer imopenlines.message.quick.save
imopenlines_message_quick_save body → 2004XX
POST
/imopenlines.message.session.start
Start a New Dialogue Based on the Message imopenlines.message.session.start
imopenlines_message_session_start body → 2004XX
POST
/imopenlines.network.join
Connect an External Open Channel to the Account imopenlines.network.join
imopenlines_network_join body → 2004XX
POST
/imopenlines.network.message.add
Send a message to a user on behalf of the Open Channel imopenlines.network.message.add
imopenlines_network_message_add body → 2004XX
POST
/imopenlines.operator.another.finish
Finish Another Operator's Dialog imopenlines.operator.another.finish
imopenlines_operator_another_finish body → 2004XX
POST
/imopenlines.operator.answer
Take the dialog for yourself imopenlines.operator.answer
imopenlines_operator_answer body → 2004XX
POST
/imopenlines.operator.finish
Finish Your Dialogue imopenlines.operator.finish
imopenlines_operator_finish body → 2004XX
POST
/imopenlines.operator.skip
Skip Dialog imopenlines.operator.skip
imopenlines_operator_skip body → 2004XX
POST
/imopenlines.operator.spam
Mark a conversation as "spam" imopenlines.operator.spam
imopenlines_operator_spam body → 2004XX
POST
/imopenlines.operator.transfer
Transfer a dialog to another operator or to another line imopenlines.operator.transfer
imopenlines_operator_transfer body → 2004XX
POST
/imopenlines.revision.get
Get Information About API Revisions imopenlines.revision.get
imopenlines_revision_get body → 2004XX
POST
/imopenlines.session.head.vote
Rate Employee Performance in the imopenlines.session.head.vote Dialog
imopenlines_session_head_vote body → 2004XX
POST
/imopenlines.session.history.get
Get Message History of the Dialogue imopenlines.session.history.get
imopenlines_session_history_get body → 2004XX
POST
/imopenlines.session.intercept
Take Over the Dialogue from the Current Operator imopenlines.session.intercept
imopenlines_session_intercept body → 2004XX
POST
/imopenlines.session.join
Join the Dialogue imopenlines.session.join
imopenlines_session_join body → 2004XX
POST
/imopenlines.session.mode.pin
Pin or Unpin a Dialog imopenlines.session.mode.pin
imopenlines_session_mode_pin body → 2004XX
POST
/imopenlines.session.mode.pinAll
Pin All Available Dialogs to the Operator imopenlines.session.mode.pinAll
imopenlines_session_mode_pinAll body → 2004XX
POST
/imopenlines.session.mode.silent
Switch the dialog to silent mode imopenlines.session.mode.silent
imopenlines_session_mode_silent body → 2004XX
POST
/imopenlines.session.mode.unpinAll
Unpin All Operator Dialogs imopenlines.session.mode.unpinAll
imopenlines_session_mode_unpinAll body → 2004XX
POST
/imopenlines.session.open
Get Chat by User Code imopenlines.session.open
imopenlines_session_open body → 2004XX
POST
/imopenlines.session.start
Start a New Dialogue imopenlines.session.start
imopenlines_session_start body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-open-lines-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
Bitrix24 BIconnector API
Bitrix24 Business Processes API
Bitrix24 Calendar API
Bitrix24 Chatbots API
Bitrix24 Chats API
Bitrix24 Company Structure API
Bitrix24 CoPilot / AI API
Bitrix24 CRM API
Bitrix24 Data Storage API
Bitrix24 Deprecated Methods API
Bitrix24 Document Generator API
Where this information came from

This is an independent, third-party profile of Bitrix24 Open Lines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.