Switch the dialog to silent mode imopenlines.session.mode.silent
Scope:
imopenlinesWho can execute the method: any user with access permission to the dialog
The method imopenlines.session.mode.silent enables or disables silent messaging mode in the dialog.
Development of the method has been halted, but it continues to function.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CHAT_ID* |
Identifier of the open line chat. The identifier can be obtained using the imopenlines.session.open or imopenlines.dialog.get methods. |
|
ACTIVATE |
Activation flag. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":2043,"ACTIVATE":"Y"}' \
https://your-domain.bitrix24.com/rest/1/webhook_key/imopenlines.session.mode.silent.json
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":2043,"ACTIVATE":"Y","auth":"<access_token>"}' \
https://your-domain.bitrix24.com/rest/imopenlines.session.mode.silent.json
try {
const response = await $b24.callMethod(
'imopenlines.session.mode.silent',
{
CHAT_ID: 2043,
ACTIVATE: 'Y',
}
);
const { result } = response.getData();
console.log(result);
} catch (error) {
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'imopenlines.session.mode.silent',
[
'CHAT_ID' => 2043,
'ACTIVATE' => 'Y',
]
);
$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 setting silent mode: ' . $exception->getMessage();
}
BX24.callMethod(
'imopenlines.session.mode.silent',
{
CHAT_ID: 2043,
ACTIVATE: 'Y',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imopenlines.session.mode.silent',
[
'CHAT_ID' => 2043,
'ACTIVATE' => 'Y',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Success: ' . print_r($result['result'], true);
}
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1773678966,
"finish": 1773678966.767325,
"duration": 0.7673249244689941,
"processing": 0,
"date_start": "2026-03-16T19:36:06+01:00",
"date_finish": "2026-03-16T19:36:06+01:00",
"operating_reset_at": 1773679566,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Returns |
|
time |
Information about the request execution time. |
Error Handling
HTTP Status: 400
{
"error": "CHAT_ID",
"error_description": "Chat ID is incorrect"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
The specified chat identifier is incorrect. |
Empty or incorrect |
|
|
|
The specified chat is not an open line. |
The specified chat does not belong to open lines. |
|
|
|
You cannot open this conversation as you do not have sufficient rights. |
The current user does not have access to the dialog. |
|
|
|
The specified user identifier is incorrect. |
The user on behalf of whom the method is executed is not defined. |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Get Chat by User Code imopenlines.session.open
- 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
- 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