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

Добавить чаты в папку

POST /v1/chats/folders/:folderId/chats

Добавляет чаты в личную папку текущего пользователя по ID чатов или идентификаторам диалогов.

Вызов изменяющий: ключ только для чтения получает 403 WRITE_BLOCKED_READONLY_KEY до обращения к Битрикс24. Создать папку — Создать папку чатов, заменить её состав целиком — Изменить папку чатов.

Параметры

Параметр Тип Обяз. Описание
folderId (path) number да ID личной папки — поле id папки с type: "personal" из GET /v1/chats/folders

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

Поле Тип Обяз. Описание
chatIds number[] нет ID чатов — поле chatId последних диалогов. Элемент — положительное целое: число или строка из цифр без ведущих нулей
dialogIds string[] нет Идентификаторы диалогов: chatXXX для группового чата — поле dialogId последних диалогов, ID пользователя для личного диалога — из списка пользователей. Элемент — непустая строка до 64 символов без запятых и пробелов по краям. Алиас me не принимается — передайте ID пользователя

Нужен хотя бы один ID в chatIds или dialogIds. Параметров запроса нет. Любой параметр запроса или другое поле тела отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/folders/16/chats" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"chatIds": [42], "dialogIds": ["chat57"]}'

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/folders/16/chats" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"chatIds": [42], "dialogIds": ["chat57"]}'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/folders/16/chats', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ chatIds: [42], dialogIds: ['chat57'] }),
})

const { success } = await res.json()

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/folders/16/chats', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ chatIds: [42], dialogIds: ['chat57'] }),
})

const { success } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — запись выполнена. Итоговый состав папки — GET /v1/chats/folders/:folderId

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

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

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

422 — системную папку пополнить нельзя:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS folderId не положительное целое, нет ни одного ID в chatIds и dialogIds, список не массив или его элемент некорректен, передан параметр запроса или неизвестное поле тела, тело — не JSON-объект. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено», код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code: FOLDER_NOT_FOUND — папки нет, FOLDER_ACCESS_DENIED — папка другого пользователя, FOLDER_SYSTEM_MUTATION_FORBIDDEN — состав системной папки менять нельзя, FOLDER_CHATS_LIMIT_EXCEEDED — в папке было бы больше 50 чатов, FOLDER_CHAT_NOT_ELIGIBLE — пользователь не состоит в чате или чат не подходит по типу. Какой из ID отклонён, ответ не сообщает
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — вызов меняет состав папки
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

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

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

  • Повторное добавление не дублирует чат. Чат, который уже лежит в папке, и один ID, переданный дважды или одновременно в chatIds и dialogIds, дают успешный ответ, и в папке чат остаётся один раз.
  • ID пользователя в dialogIds создаёт личный диалог, если его ещё нет.
  • dialogIds работает начиная с обновления im 26.1000.0. В облачном Битрикс24 оно уже установлено. Коробочный Битрикс24 без этого обновления молча пропускает dialogIds, и запрос с одними dialogIds ответит успехом, ничего не изменив. На таком портале передавайте chatIds.

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