метод REST scope: imbot

imbot.v2.Chat.Message.read

Отметить сообщения как прочитанные

Кто может выполнять: владелец зарегистрированного бота

Описание

Метод imbot.v2.Chat.Message.read отмечает сообщения как прочитанные от имени бота. Отмечает прочитанными все сообщения до указанного включительно. Если messageId не указан — отмечает прочитанными все сообщения в чате.

Типичный сценарий: бот обработал входящее сообщение из события ONIMBOTV2MESSAGEADD и сбрасывает счетчик непрочитанных, чтобы у пользователя не оставалось «висящих» уведомлений. В ответе возвращается оставшийся счетчик counter.

Параметры

botId integer обязательный

ID бота

botToken string необязательный

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте тот же botToken, который был указан при регистрации чат-бота

dialogId string обязательный

ID диалога. Для групповых чатов — chat{chatId}, для личных — {userId}. Подробнее — Формат dialogId

messageId integer необязательный

Прочитать все сообщения до этого включительно. Если не указан — прочитает все сообщения в чате

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","messageId":789}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.Message.read

Ответ

HTTP-статус: 200

{
    "result": {
        "chatId": 5,
        "lastId": 789,
        "counter": 0,
        "viewedMessages": [785, 786, 789]
    },
    "time": {
        "start": 1728626400.123,
        "finish": 1728626400.234,
        "duration": 0.111,
        "processing": 0.045,
        "date_start": "2024-10-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00"
    }
}

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied"
}
Код Описание Значение
BOT_TOKEN_NOT_SPECIFIED Bot token is not specified Не указан botToken. Обязателен при авторизации через вебхук
BOT_ID_REQUIRED Bot ID is required Не указан botId
BOT_NOT_FOUND Bot not found Бот не найден
BOT_OWNERSHIP_ERROR Bot is registered by another application Бот зарегистрирован другим приложением
ACCESS_DENIED Access denied Бот не является участником чата
MESSAGE_NOT_FOUND Message not found Указанное сообщение не найдено или недоступно

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.