#Прочитать сообщения

POST /v1/bots/:botId/chats/:dialogId/read

Отмечает сообщения как прочитанные от имени бота. Без messageId прочитает все сообщения в чате.

#Параметры

Параметр Тип Обяз. По умолч. Описание
botId (path) number да — ID бота
dialogId (path) string да — ID диалога: числовой ID пользователя для личных сообщений, chatXXX для групповых
messageId (body) number нет — Прочитать все сообщения до этого включительно. Без параметра — прочитать все

#Примеры

#curl — личный ключ

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/read \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "messageId": 1501 }'

#curl — OAuth-приложение

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/read \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "messageId": 1501 }'

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/read', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ messageId: 1501 }),
})

const { success, data } = await res.json()
console.log('Прочитано до:', data.lastId)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/read', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ messageId: 1501 }),
})

const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
chatId number ID чата
lastId number ID последнего прочитанного сообщения
counter number Оставшееся количество непрочитанных
viewedMessages number[] ID прочитанных сообщений

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "chatId": 456,
    "lastId": 1501,
    "counter": 0,
    "viewedMessages": [1499, 1500, 1501]
  }
}

#Пример ответа при ошибке

404 — бот не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "BOT_NOT_FOUND",
    "message": "Bot 999 not found. Register it first via POST /v1/bots."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Bitrix24 (текст ошибки в message)
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

#Известные особенности

Без messageId: если не передать messageId, будут прочитаны все сообщения в чате.

Чтение до сообщения: при указании messageId прочитываются все сообщения до указанного включительно, а не только это одно сообщение.

#Смотрите также