Для AI-агентов: markdown этой страницы — /docs-content/chats/messages/personal-pins.md индекс документации — /llms.txt
Получить личные закреплённые сообщения
GET /v1/chats/:dialogId/pins/personal
Возвращает постранично сообщения, которые текущий пользователь закрепил для себя в одном чате.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрdialogId (path) |
Типstring | Обяз.да | Описаниеchat и реальный ID чата из загрузки чата, в том числе личного. Числовой ID собеседника и me отклоняются |
Параметрlimit (query) |
Типinteger | Обяз.нет | ОписаниеСтрок на страницу: 1–200, по умолчанию 50. Выход за границы ограничивается с отражением в meta.requestedLimit и meta.appliedLimit |
ПараметрlastId (query) |
Типinteger | Обяз.нет | ОписаниеИсключающий курсор: messageId последней строки предыдущей страницы |
Параметрorder (query) |
Типstring | Обяз.нет | Описаниеdesc по умолчанию либо asc |
Нужен скоуп im. Текущий пользователь определяется по токенам авторизации. Параметры выбора владельца и неизвестные параметры отклоняются. Если чат разрешает автовступление, чтение может добавить пользователя в участники.
Примеры
curl — личный ключ
curl -X GET "https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X GET "https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { data } = await res.json()
console.log(data)
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal', {
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.personalPins |
Типarray | ОписаниеСтроки личных закрепов |
Полеdata.personalPins[].id |
Типnumber | ОписаниеID строки закрепа |
Полеdata.personalPins[].messageId |
Типnumber | ОписаниеID сообщения и курсор следующей страницы |
Полеdata.personalPins[].chatId |
Типnumber | ОписаниеРеальный ID чата |
Полеdata.personalPins[].authorId |
Типnumber | ОписаниеID владельца закрепа |
Полеdata.personalPins[].dateCreate |
Типstring | ОписаниеДата закрепления |
Полеdata.hasNextPage |
Типboolean | ОписаниеЕсть ли следующая страница |
Полеdata.messages, data.additionalMessages |
Типarray | ОписаниеЗакреплённые сообщения: id, chatId, authorId, date, text, isSystem. Каждое из двух полей приходит не в каждом ответе |
Полеdata.users |
Типarray | ОписаниеСвязанные пользователи |
Полеdata.files, data.reactions, data.stickers |
Типarray | ОписаниеФайлы, реакции и стикеры закреплённых сообщений. Приходят не в каждом ответе: в пустой выдаче их нет |
Полеdata.tariffRestrictions.isHistoryLimitExceeded |
Типboolean | Описаниеtrue, когда тариф скрывает часть старой истории чата и её сообщения не попадают в выдачу |
Полеmeta.requestedLimit |
Типnumber | ОписаниеПереданный limit. Приходит вместе с appliedLimit, только когда значение вышло за диапазон от 1 до 200 |
Полеmeta.appliedLimit |
Типnumber | ОписаниеПрименённое значение limit — только если оно было приведено к границе |
Пример ответа
Показаны основные поля сообщений и пользователя.
{
"success": true,
"data": {
"personalPins": [
{
"id": 12,
"messageId": 846,
"chatId": 1945,
"authorId": 7,
"dateCreate": "2026-11-17T10:05:00+03:00"
},
{
"id": 11,
"messageId": 845,
"chatId": 1945,
"authorId": 7,
"dateCreate": "2026-11-17T10:04:00+03:00"
}
],
"additionalMessages": [
{"id": 846, "chatId": 1945, "authorId": 12, "date": "2026-11-16T09:30:00+03:00", "text": "Release notes are ready", "isSystem": false},
{"id": 845, "chatId": 1945, "authorId": 12, "date": "2026-11-16T09:28:00+03:00", "text": "Project update", "isSystem": false}
],
"users": [{"id": 12, "active": true, "name": "Anna Smith", "type": "user"}],
"files": [],
"reactions": [],
"stickers": [],
"tariffRestrictions": {"isHistoryLimitExceeded": false},
"hasNextPage": false
}
}
Пример ответа при ошибке
400 — передан неизвестный параметр:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "Query parameter `ownerId` is not accepted by GET /v1/chats/:dialogId/pins/personal. Accepted: lastId, order, limit."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеНекорректный ID, неизвестный или повторный параметр либо поле тела |
| HTTP422 | КодBITRIX_ERROR |
Описаниеerror.b24Code равен CHAT_NOT_FOUND — чата с таким ID нет |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан API-ключ |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеНет настроенных токенов Битрикс24 |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеУ ключа нет скоупа im |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч в режиме READONLY не является обычным личным ключом сотрудника: это ключ приложения с пользовательской сессией, ключ управления или ключ неподтверждённого типа. Проверяется до обращения к Битрикс24 |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ОписаниеУ текущего пользователя нет доступа |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеЗапись не найдена |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 отклонил операцию с другим кодом, он — в error.b24Code |
Общие ошибки API — Ошибки.
Известные особенности
При полной загрузке чата начальный блок личных закрепов приходит в объекте data: personalPins и personalPinsHasNextPage. Этот метод нужен для постраничного чтения. Если при полной загрузке блока нет, возможность не поддерживается. Пустой список передаётся как personalPins: [].