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

Убрать загруженный файл

POST /v1/chats/:chatId/files/uploads/discard

Просит Битрикс24 удалить файл из папки чата. Ответ true или false передаётся как есть: клиент сам решает, можно ли считать файл убранным.

Параметры

Параметр Тип Обяз. Описание
chatId (path) number да ID чата
fileId (body) number да Положительный ID файла

Нужен скоуп im и ключ с правом записи. Другие поля и параметры запроса отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/42/files/uploads/discard \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileId":7701}'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/42/files/uploads/discard \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fileId":7701}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/42/files/uploads/discard', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"fileId": 7701}),
})
const { success, data, error } = await res.json()
console.log(success ? data : error)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/42/files/uploads/discard', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"fileId": 7701}),
})
const { success, data, error } = await res.json()
console.log(success ? data : error)

Поля ответа

Поле Тип Описание
success boolean true при успехе
data boolean Ответ портала true или false без свёртки

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

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`fileId` must be a positive integer."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS fileId не положительное целое число, передано другое поле тела или параметр строки запроса
400 INVALID_CHAT_ID chatId в пути не положительное целое число
401 TOKEN_MISSING Нет токенов портала
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения
403 BITRIX_ACCESS_DENIED Нет доступа к чату или файлу на портале
404 ENTITY_NOT_FOUND Файл или чат не найден
422 BITRIX_ERROR Другой отказ портала
429 QUEUE_TIMEOUT Очередь портала перегружена

false остаётся успешным ответом и отличается от отказа. Именованный отказ портала может стать 400, 403 или 404; error.b24Code не гарантирован. Платформа не повторяет вызов после неизвестного исхода.

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

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