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

Папка чата на Диске

GET /v1/chats/:chatId/folder

Возвращает идентификатор папки чата в Битрикс24 Диске. Файлы, загружаемые в чат через POST /v1/chats/:chatId/files, хранятся в этой папке.

Для вызова нужен скоуп im и режим READWRITE. Метод Битрикс24 может создать отсутствующую папку чата и сохранить её привязку. Поэтому ключи в режиме READONLY получают 403 WRITE_BLOCKED_READONLY_KEY до отправки этого метода, несмотря на HTTP GET. Список файлов, метаданные и скачивание содержимого сохраняют свои правила чтения.

Параметры

Параметр Тип Обяз. Описание
chatId (path) number да ID чата. Получить: POST /v1/chats или GET /v1/chats/recent

Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Folder ID:', data.id)

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

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

const { success, data } = await res.json()
console.log('Folder ID:', data.id)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number ID папки чата на Диске

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

JSON 
{
  "success": true,
  "data": {
    "id": 9263
  }
}

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

400 — chatId не положительное целое. Маршрут проверяет это до обращения в Битрикс24:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_CHAT_ID",
    "message": "chatId must be a positive integer."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_CHAT_ID chatId не является положительным целым числом — проверяется до обращения в Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул ошибку NOT_FOUND — чат не существует или недоступен
422 BITRIX_ERROR Ошибка Битрикс24 при получении папки
403 WRITE_BLOCKED_READONLY_KEY Режим READONLY запрещает инициализацию папки до вызова Битрикс24
403 SCOPE_DENIED Ключу не хватает скоупа im
401 TOKEN_MISSING Ключ не имеет настроенных токенов Битрикс24

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

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