Set the "read" flag for messages im.dialog.read

Scope: im

Who can execute the method: any user

The method im.dialog.read sets the "read" flag for dialog messages up to and including the specified message.

Method Parameters

Required parameters are marked with *

Name
type

Description

DIALOG_ID*
string

Identifier of the chat in the format:

chatXXX — chat
sgXXX — group or project chat
XXX — identifier of the personal chat user

The chat identifier can be obtained using the im.chat.get method. The user identifier can be obtained using the user.get and user.search methods

MESSAGE_ID
integer

Identifier of the last read message. If not provided, the method sets the read flag for all unread messages

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat1489","MESSAGE_ID":84875}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.read

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat1489","MESSAGE_ID":84875,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.dialog.read

try
        {
            const response = await $b24.callMethod(
                'im.dialog.read',
                {
                    DIALOG_ID: 'chat1489',
                    MESSAGE_ID: 84875
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.dialog.read',
                [
                    'DIALOG_ID' => 'chat1489',
                    'MESSAGE_ID' => 84875,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            error_log($e->getMessage());
        }

BX24.callMethod(
            'im.dialog.read',
            {
                DIALOG_ID: 'chat1489',
                MESSAGE_ID: 84875
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.dialog.read',
            [
                'DIALOG_ID' => 'chat1489',
                'MESSAGE_ID' => 84875,
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "dialogId": "chat1489",
                "chatId": 1489,
                "lastId": 84875,
                "counter": 3
            },
            "time": {
                "start": 1772624912,
                "finish": 1772624912.615753,
                "duration": 0.6157529354095459,
                "processing": 0,
                "date_start": "2026-03-04T14:48:32+01:00",
                "date_finish": "2026-03-04T14:48:32+01:00",
                "operating_reset_at": 1772625512,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response (detailed description).

Returns false if the user does not have access to the chat

time
time

Information about the request execution time

Result Object

Name `type`	Description
dialogId `string`	Identifier of the dialog
chatId `integer`	Identifier of the chat
lastId `integer`	Identifier of the last read message
counter `integer`	Number of unread messages after executing the method

Error Handling

HTTP Status: 400

{
            "error": "DIALOG_ID_EMPTY",
            "error_description": "Dialog ID can't be empty"
        }

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`	`DIALOG_ID_EMPTY`	Dialog ID can't be empty	The `DIALOG_ID` parameter was not provided, was empty, or was in an incorrect format

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

Find Message in Chat

Set "Unread" Status for Messages

Set the "read" flag for messages im.dialog.read

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning