Установить признак «не прочитано» у сообщений im.dialog.unread

Scope: im

Кто может выполнять метод: любой пользователь

Метод im.dialog.unread устанавливает признак «не прочитано» для сообщений в диалоге начиная с указанного сообщения.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

DIALOG_ID*
string

Идентификатор чата в формате:

chatXXX — чат
sgXXX — чат группы или проекта
XXX — идентификатор пользователя личного чата

Идентификатор чата можно получить с помощью метода im.chat.get. Идентификатор пользователя — с помощью методов user.get и user.search

MESSAGE_ID*
integer

Идентификатор первого непрочитанного сообщения

Примеры кода

Как использовать примеры в документации

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":84869}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.unread

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

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

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

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

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

Обработка ответа

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1772624862,
                "finish": 1772624862.090708,
                "duration": 0.09070801734924316,
                "processing": 0,
                "date_start": "2026-03-04T14:47:42+03:00",
                "date_finish": "2026-03-04T14:47:42+03:00",
                "operating_reset_at": 1772625462,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `boolean`	Возвращает `true`, если признак непрочитанных сообщений установлен успешно
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "MESSAGE_ID_ERROR",
            "error_description": "Message ID can't be empty"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус	Код	Описание	Значение
`400`	`MESSAGE_ID_ERROR`	First unread message id can't be empty	Параметр `MESSAGE_ID` не передан или передан со значением меньше или равным `0`
`400`	`DIALOG_ID_EMPTY`	Dialog ID can't be empty	Параметр `DIALOG_ID` не передан, передан пустым или в неверном формате

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Установить признак «прочитано» у сообщений

Отправить признак «Пользователь пишет»

Установить признак «не прочитано» у сообщений im.dialog.unread

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение