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

Отметить прочитанными все комментарии канала

POST /v1/chats/:dialogId/comments/read-all

Отмечает для вас прочитанными все комментарии ко всем постам канала.

Параметры

Параметр Тип Обяз. По умолч. Описание
dialogId (path) string да — ID диалога канала, chatXXX — поле dialogId строки последних диалогов. Алиас me адресует ваш личный диалог, а не канал, и получает 422 WRONG_MESSAGE_TYPE

Тело не нужно. Параметры запроса и поля тела отклоняются с 400 INVALID_PARAMS.

Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/chat2000/comments/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/chat2000/comments/read-all', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Комментарии прочитаны:', data.result)

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

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

const { data } = await res.json()
console.log('Комментарии прочитаны:', data.result)

Поля ответа

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

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

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

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

422 — чат не канал:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "WRONG_MESSAGE_TYPE",
    "b24Code": "WRONG_MESSAGE_TYPE"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Тело не JSON-объект, передан параметр запроса или поле тела. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул общий код «не найдено» или ошибку с текстом «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. CHAT_NOT_FOUND — чата с таким dialogId нет, WRONG_MESSAGE_TYPE — чат не канал
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения: отметка комментариев прочитанными изменяет данные — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить текущего пользователя для dialogId = me

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

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

Повторный вызов не ошибка. Если непрочитанных комментариев в канале нет, ответ тоже true.

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