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

Число закреплённых сообщений

GET /v1/chats/:dialogId/pins/count

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

Параметры

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

Параметры запроса не принимаются: любой из них отклоняется с 400 INVALID_PARAMS.

Примеры

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

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

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

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

const { data } = await res.json()
console.log('Закреплено:', data.counter)

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

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

const { data } = await res.json()
console.log('Закреплено:', data.counter)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.counter number Число закреплённых сообщений

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

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

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

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

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр запроса. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено», код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку, код — в error.b24Code, например CHAT_NOT_FOUND — чата нет
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Режим только чтения: существующий чат не подтверждён в ограниченном окне последних диалогов либо передан создающий или неоднозначный алиас. Вызывающий создание метод не отправляется на портал
403 WRITE_BLOCKED_READONLY_KEY Чтение в режиме READONLY недоступно ключу приложения, менеджмент-ключу или ключу с неподтверждённым видом владельца
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 ME_ALIAS_RESOLUTION_FAILED Алиас me не удалось разрешить: Битрикс24 не вернул ID текущего пользователя

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

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

Запрос может сделать вас участником. Если чат разрешает автовступление, вызов может добавить текущего пользователя в участники, как загрузка чата. Обычному личному ключу сотрудника в режиме READONLY это чтение доступно. Сообщения прочитанными оно не отмечает.

Считается видимая история. Если вам видна история чата не с начала — например, вас добавили позже без доступа к старым сообщениям, — закрепы до этой границы не учитываются.

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