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

Порядок закреплённого чата

PUT /v1/chats/:dialogId/pin

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

Параметры

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

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

Поля запроса (body)

Поле Тип Обяз. Описание
position integer да Место чата среди закреплённых, начиная с 1. Целое число JSON, строка "3" не принимается. Наибольшее место — 45, по числу закреплённых чатов, которое допускает портал

Другие поля тела отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat456/pin \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"position": 1}'

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

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat456/pin \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"position": 1}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat456/pin', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ position: 1 }),
})

const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat456/pin', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ position: 1 }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — порядок сохранён

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

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

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

422 — место больше 45:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Нет position, запрос без тела, position не целое число JSON или меньше 1, лишнее поле тела или параметр запроса. Проверяется до обращения к Битрикс24
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. INVALID_PIN_POSITION — position больше 45. CHAT_NOT_FOUND — чата с таким dialogId нет
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено», код портала — в error.b24Code
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить пользователя при использовании алиаса me
403 BITRIX_ACCESS_DENIED У пользователя нет доступа к чату
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения: порядок закрепа — запись, см. права доступа
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Порядок хранится, но список диалогов его пока не показывает. После вызова последние диалоги отдают закреплённые чаты в прежнем порядке — по времени последней активности. Сохранённое место пригодится, когда список начнёт его учитывать, а до тех пор порядок закреплённых чатов в своём интерфейсе храните на своей стороне.

Незакреплённый чат и место за пределами закреплённых. Для чата без закрепа и для position, большего числа закреплённых чатов, но не больше 45, ответ — true, а порядок не меняется. Проверяйте pinned в последних диалогах до вызова.

Вызов может сделать вас участником. Если чат разрешает автовступление — например, чат комментариев, коллаб или чат задачи, — вызов добавляет текущего пользователя в участники так же, как открытие чата в интерфейсе Битрикс24.

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