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

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

GET /v1/chats/counters

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

Параметры

Параметров нет. Любой параметр запроса отклоняется с 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 Код Описание
400 INVALID_PARAMS Передан параметр запроса — эндпоинт их не принимает
403 SCOPE_DENIED API-ключ не имеет скоупа im
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
422 BITRIX_ERROR Битрикс24 вернул ошибку; код портала — в error.b24Code
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

  • Ключи ответа приводятся к camelCase, значения приходят как есть.

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