Файлы

Загружайте файлы в чат от имени бота и скачивайте файлы, которые присылают пользователи.

Скоуп: imbot | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

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

POST /v1/bots/:botId/files

Загружает файл в чат от имени бота. Содержимое передаётся в base64. Максимальный размер — 100 МБ.

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

Параметр Тип Обяз. Описание
dialogId string да ID диалога: числовой ID пользователя для личных, chatXXX для групповых
file.name string да Имя файла с расширением
file.content string да Содержимое файла в base64
message string нет Текст сообщения, прикреплённый к файлу

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/files \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "dialogId": "chat123",
    "file": {
      "name": "report.pdf",
      "content": "JVBERi0xLjQKJcOkw7zDtsOfCjEgMCBv..."
    },
    "message": "Вот запрошенный отчёт"
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/bots/42/files \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dialogId": "chat123",
    "file": {
      "name": "report.pdf",
      "content": "JVBERi0xLjQKJcOkw7zDtsOfCjEgMCBv..."
    },
    "message": "Вот запрошенный отчёт"
  }'

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

javascript 
import { readFileSync } from 'fs'

const base64 = readFileSync('./report.pdf').toString('base64')

const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/files', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dialogId: 'chat123',
    file: { name: 'report.pdf', content: base64 },
    message: 'Вот запрошенный отчёт',
  }),
})

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

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

javascript 
import { readFileSync } from 'fs'

const base64 = readFileSync('./report.pdf').toString('base64')

const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/files', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    dialogId: 'chat123',
    file: { name: 'report.pdf', content: base64 },
    message: 'Вот запрошенный отчёт',
  }),
})

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

Поля ответа

Поле Тип Описание
file object Данные загруженного файла
file.id number ID загруженного файла (используйте его для GET /v1/bots/:botId/files/:fileId)
file.chatId number Числовой ID чата
file.name string Имя файла
file.extension string Расширение файла
file.size number Размер файла в байтах
messageId number ID созданного сообщения с файлом
chatId number Числовой ID чата
dialogId string ID диалога

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

JSON 
{
  "success": true,
  "data": {
    "file": {
      "id": 789,
      "chatId": 5,
      "name": "report.pdf",
      "extension": "pdf",
      "size": 35341
    },
    "messageId": 1520,
    "chatId": 5,
    "dialogId": "chat123"
  }
}

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

502 — ошибка Битрикс24:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "File size exceeds limit"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
502 BITRIX_ERROR Ошибка Битрикс24 при загрузке
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Base64: содержимое файла передаётся целиком в base64. Для больших файлов это увеличивает размер body на ~33%.

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

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