#Загрузить файл в чат

POST /v1/chats/:chatId/files

Загружает файл в чат. Содержимое передаётся в base64 и публикуется в чате как сообщение. Возвращает HTTP 201 с идентификатором и метаданными загруженного файла.

#Параметры

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

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

Поле Тип Обяз. Описание
filename string да Имя файла с расширением
content string да Содержимое файла в кодировке base64
message string нет Текст сообщения, прикреплённый к файлу в том же сообщении

#Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/1001/files \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "report.pdf",
    "content": "aGVsbG8=",
    "message": "Отчёт за период"
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/1001/files \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "report.pdf",
    "content": "aGVsbG8=",
    "message": "Отчёт за период"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/1001/files', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filename: 'report.pdf',
    content: 'aGVsbG8=',
    message: 'Отчёт за период',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/1001/files', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filename: 'report.pdf',
    content: 'aGVsbG8=',
    message: 'Отчёт за период',
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.fileId number ID загруженного файла. Используйте для GET /v1/chats/files/:fileId
data.name string Имя файла
data.size string Размер файла в байтах
data.downloadUrl string Ссылка для скачивания файла

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

JSON 
{
  "success": true,
  "data": {
    "fileId": 9265,
    "name": "report.pdf",
    "size": "24576",
    "downloadUrl": "https://YOUR_PORTAL.bitrix24.tech/rest/download/?token=..."
  }
}

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

400 — не переданы обязательные поля:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: filename (string) and content (base64-encoded file content)"
  }
}

#Ошибки

HTTP Код Описание
400 MISSING_PARAMS Не переданы обязательные поля filename или content
404 FOLDER_NOT_FOUND Папка чата на Диске не найдена
500 UPLOAD_FAILED Загрузка файла не выполнена
422 BITRIX_ERROR Ошибка Битрикс24 при загрузке
403 SCOPE_DENIED Ключу не хватает скоупа im
401 TOKEN_MISSING Ключ не имеет настроенных токенов Битрикс24

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

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

Три шага за один вызов. Загрузка выполняется в три шага: получение папки чата, загрузка файла на Диск, публикация в чате. При сбое на любом шаге возвращается соответствующая ошибка.

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

Base64 и размер тела. Кодировка base64 увеличивает размер тела запроса примерно на 33% по сравнению с исходным файлом.

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