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

Счётчики непрочитанного

GET /v1/chats/counters

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

Параметры

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

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/counters" \
  -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/counters', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
const unread = data.userCounters.filter((c) => c.counter > 0 && !c.isMuted)
console.log('Чатов с непрочитанным:', unread.length)

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

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

const { data } = await res.json()
const unread = data.userCounters.filter((c) => c.counter > 0 && !c.isMuted)
console.log('Чатов с непрочитанным:', unread.length)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.userCounters Типarray ОписаниеСчётчики по чатам, где есть непрочитанное или метка «непрочитано»
Полеdata.userCounters[].chatId Типnumber ОписаниеID чата — открыть чат: загрузка чата с dialogId вида chat<chatId>
Полеdata.userCounters[].counter Типnumber ОписаниеЧисло непрочитанных сообщений
Полеdata.userCounters[].parentChatId Типnumber ОписаниеID родительского чата для чатов комментариев, иначе 0. Открывается так же, как chatId
Полеdata.userCounters[].isMuted Типboolean ОписаниеУведомления чата выключены
Полеdata.userCounters[].isMarkedAsUnread Типboolean ОписаниеЧат вручную отмечен непрочитанным
Полеdata.userCounters[].recentSections Типarray ОписаниеРазделы списка, в которых чат учитывается (default, chat, tasksTask и другие)

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

JSON 
{
  "success": true,
  "data": {
    "userCounters": [
      {
        "chatId": 1945,
        "counter": 3,
        "parentChatId": 0,
        "isMuted": false,
        "isMarkedAsUnread": false,
        "recentSections": ["default"]
      }
    ]
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `unreadOnly` is not accepted by GET /v1/chats/counters. It takes no query parameters."
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеПередан параметр запроса — эндпоинт их не принимает
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа im
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов Битрикс24
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 вернул ошибку. Код портала — в error.b24Code
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен или вернул ошибку сервера

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

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