Для AI-агентов: markdown этой страницы — /docs-content/chats/management/read-section.md индекс документации — /llms.txt

Прочитать раздел списка

POST /v1/chats/recent/read

Отмечает прочитанными все чаты одного раздела списка диалогов текущего пользователя — например, все чаты задач — и обнуляет их счётчики непрочитанного. Остальные разделы не меняются.

Параметры

Параметры запроса не принимаются: любой отклоняется с 400 INVALID_PARAMS.

Поля запроса (body)

Поле Тип Обяз. Описание
section string да Код раздела: латинская буква, затем буквы, цифры или _, до 64 символов. Разделы, в которых учитывается чат, приходят в поле recentSections счётчиков непрочитанного
parentId integer нет ID чата, чьих потомков прочитать, например комментарии канала. Целое число JSON, не меньше 1. Без поля читается весь раздел

Другие поля тела отклоняются с 400 INVALID_PARAMS.

Коды разделов на порталах Битрикс24: default — общий список, chat — групповые чаты, channel и openChannel — каналы, collab — коллабы, copilot — чаты с AI-ассистентом, lines — открытые линии, tasksTask — чаты задач, calendar — чаты встреч календаря.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/recent/read \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"section": "tasksTask"}'

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

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

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

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

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

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — раздел прочитан. Приходит и тогда, когда читать было нечего

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

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

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

400 — нет поля section:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`section` is required: the recent-list section to read, e.g. `default`."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Нет section, запрос без тела, section не код раздела, parentId не целое число JSON или меньше 1, лишнее поле тела или параметр запроса. Проверяется до обращения к Битрикс24
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения: прочтение — запись, см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Неизвестный раздел — успех без эффекта. Код раздела, которого нет на портале, отвечает true, и ни один счётчик не меняется. Опечатку в section ответ не покажет: сверяйте код с полем recentSections счётчиков непрочитанного.

Вызов нельзя отменить. Метки «непрочитано» и счётчики чатов раздела сбрасываются сразу. Прочтение личное: меняются счётчики только того пользователя, от имени которого идёт вызов.

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