Switch the dialog to silent mode imopenlines.session.mode.silent

Scope: imopenlines

Who 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
type

Description

CHAT_ID*
integer

Identifier of the open line chat.

The identifier can be obtained using the imopenlines.session.open or imopenlines.dialog.get methods.

ACTIVATE
string

Activation flag. Y — enable silent mode, any other value disables it. By default, the mode is off.

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
type

Description

result
boolean

Returns true if the mode is applied.

time
time

Information about the request execution time.

Error Handling

HTTP Status: 400

{
            "error": "CHAT_ID",
            "error_description": "Chat ID is incorrect"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

400

CHAT_ID

The specified chat identifier is incorrect.

Empty or incorrect CHAT_ID.

400

CHAT_TYPE

The specified chat is not an open line.

The specified chat does not belong to open lines.

400

ACCESS_DENIED

You cannot open this conversation as you do not have sufficient rights.

The current user does not have access to the dialog.

400

USER_ID

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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