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

GET /v1/chats/:chatId/folder

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

#Параметры

Параметр Тип Обяз. Описание
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
  }
}

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

404 — папка не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "FOLDER_NOT_FOUND",
    "message": "Chat disk folder not found"
  }
}

#Ошибки

HTTP Код Описание
404 FOLDER_NOT_FOUND Папка чата на Диске не найдена
404 ENTITY_NOT_FOUND Битрикс24 вернул ошибку NOT_FOUND — чат не существует или недоступен
422 BITRIX_ERROR Ошибка Битрикс24 при получении папки
403 SCOPE_DENIED Ключу не хватает скоупа im
401 TOKEN_MISSING Ключ не имеет настроенных токенов Битрикс24

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

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