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

Посчитать избранные сообщения

GET /v1/chats/:dialogId/favorites/count

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

Параметры

Параметр Тип Обяз. Описание
ПараметрdialogId (path) Типstring Обяз.да Описаниеchat и реальный ID чата из загрузки чата, в том числе личного. Числовой ID собеседника и me отклоняются

Нужен скоуп im. Текущий пользователь определяется по токенам авторизации. Параметры выбора владельца и неизвестные параметры отклоняются.

Примеры

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

Terminal
curl -X GET "https://vibecode.bitrix24.tech/v1/chats/chat1945/favorites/count" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl -X GET "https://vibecode.bitrix24.tech/v1/chats/chat1945/favorites/count" \
  -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/chat1945/favorites/count', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { data } = await res.json()
console.log(data)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat1945/favorites/count', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()
console.log(data)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue
Полеdata.counter Типnumber ОписаниеСчётчик избранных сообщений

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

JSON
{
  "success": true,
  "data": {
    "counter": 3
  }
}

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

400 — передан неизвестный параметр:

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный ID, неизвестный или повторный параметр либо поле тела
HTTP422 КодBITRIX_ERROR Описаниеerror.b24Code равен ACCESS_ERROR — у сотрудника нет доступа к чату или чата нет
HTTP401 КодMISSING_API_KEY ОписаниеНе передан API-ключ
HTTP401 КодTOKEN_MISSING ОписаниеНет настроенных токенов Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа im
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ текущего пользователя нет доступа
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗапись не найдена
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил операцию с другим кодом, он — в error.b24Code

Общие ошибки API — Ошибки.

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