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

Прочитать все чаты

POST /v1/chats/read-all

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

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

Параметры

Параметров нет. Тело запроса не передаётся. Любой параметр запроса или поле тела отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/read-all \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/read-all \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/read-all', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/read-all', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

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

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

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

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

400 — передано тело запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `all` is not accepted by POST /v1/chats/read-all. It takes no body fields."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр запроса или поле тела. Проверяется до обращения к Битрикс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 — Ошибки.

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

Прочтение личное. Сбрасываются счётчики только того пользователя, от имени которого идёт вызов. С личным ключом это владелец ключа, с ключом приложения и сессией vibe_session_* — сотрудник, открывший приложение.

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