Get Chat by User Code imopenlines.session.open
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
imopenlinesWho can execute the method: any user with access permission to the dialogue
The method imopenlines.session.open returns the chat ID of the open line based on the user code USER_CODE.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
USER_CODE* |
String code of the user for the external system channel. Code format:
The value can be obtained using the method imopenlines.dialog.get from the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_CODE":"livechat|22|1761|587"}' \
https://your-domain.bitrix24.com/rest/1/webhook_key/imopenlines.session.open.json
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"USER_CODE":"livechat|22|1761|587","auth":"<access_token>"}' \
https://your-domain.bitrix24.com/rest/imopenlines.session.open.json
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SessionOpenResult = {
chatId: number
}
try {
const response = await $b24.actions.v2.call.make<SessionOpenResult>({
method: 'imopenlines.session.open',
params: {
USER_CODE: 'livechat|22|1761|587',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Chat ID:', result.chatId)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function openSession() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imopenlines.session.open',
params: {
USER_CODE: 'livechat|22|1761|587',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Chat ID:', result.chatId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', openSession)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imopenlines.session.open(
user_code="livechat|22|1761|587",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'imopenlines.session.open',
[
'USER_CODE' => 'livechat|22|1761|587',
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $exception) {
error_log($exception->getMessage());
echo 'Error opening chat: ' . $exception->getMessage();
}
BX24.callMethod(
'imopenlines.session.open',
{
USER_CODE: 'livechat|22|1761|587',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imopenlines.session.open',
[
'USER_CODE' => 'livechat|22|1761|587',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Success: ' . print_r($result['result'], true);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imopenlines.session.open", b24.Params{
"USER_CODE": "livechat|22|1761|587",
})
if err != nil {
return fmt.Errorf("imopenlines.session.open: %w", err)
}
var item struct {
ChatID b24.ID `json:"chatId"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ChatID)
Response Handling
HTTP Status: 200
{
"result": {
"chatId": "1763"
},
"time": {
"start": 1773666416,
"finish": 1773666416.279787,
"duration": 0.2797870635986328,
"processing": 0,
"date_start": "2026-03-16T16:06:56+01:00",
"date_finish": "2026-03-16T16:06:56+01:00",
"operating_reset_at": 1773667016,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root object of the response (detailed description) |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
chatId |
Identifier of the open line chat |
Error Handling
HTTP Status: 400
{
"error": "ACCESS_DENIED",
"error_description": "You cannot open this conversation because you do not have sufficient permissions"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
You cannot open this conversation because you do not have sufficient permissions |
No access to the chat with the specified |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Start a New Dialogue imopenlines.session.start
- Join the Dialogue imopenlines.session.join
- Get Message History of the Dialogue imopenlines.session.history.get
- Take Over the Dialogue from the Current Operator imopenlines.session.intercept
- Pin or Unpin a Dialog imopenlines.session.mode.pin
- Pin All Available Dialogs to the Operator imopenlines.session.mode.pinAll
- Unpin All Operator Dialogs imopenlines.session.mode.unpinAll
- Switch the dialog to silent mode imopenlines.session.mode.silent
- Rate Employee Performance in the imopenlines.session.head.vote Dialog
- Start a New Dialogue Based on the Message imopenlines.message.session.start
- Create a Lead Based on the Dialogue imopenlines.crm.lead.create
- Get Information About the Operator's Dialog imopenlines.dialog.get