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

Закрепить сообщение

POST /v1/chats/messages/:messageId/pin

Закрепляет сообщение в чате, к которому оно относится, и добавляет его в список закреплённых сообщений. Чат определяется по сообщению, dialogId не нужен.

Параметры

Параметр Тип Обяз. Описание
messageId (path) number да ID сообщения, положительное целое — из ленты чата (GET /v1/chats/:dialogId/messages) или из ответа отправки

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

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/messages/1001/pin" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Пустой массив

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

JSON 
{
  "success": true,
  "data": []
}

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

422 — сообщение уже закреплено:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "MESSAGE_IS_ALREADY_PIN",
    "b24Code": "MESSAGE_IS_ALREADY_PIN"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS messageId не положительное целое, передано поле тела или параметр запроса. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено», код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку, код — в error.b24Code: MESSAGE_IS_ALREADY_PIN — сообщение уже закреплено, MESSAGE_NOT_FOUND — сообщения нет
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения не может закреплять сообщения — см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

Закрепление видно в чате. В чате появляется системное сообщение о закреплении с цитатой закреплённого текста. Оно остаётся в чате и после открепления.

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