Загрузить файл в чат imbot.v2.File.upload

Scope: imbot

Кто может выполнять метод: владелец зарегистрированного бота

Метод imbot.v2.File.upload загружает файл в чат от имени бота. Объединяет три шага устаревшего API в один вызов: загрузку файла на диск, прикрепление к чату и отправку сообщения.

Параметры метода

Обязательные параметры отмечены *

Название
Тип

Описание

botId*
integer

ID бота

botToken
string

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте тот же botToken, который был указан при регистрации чат-бота

dialogId*
string

ID диалога. Для групповых чатов — chat{chatId}, для личных — {userId}

fields*
object

Данные файла и сообщения. Структура описана ниже

Параметр fields

Название
Тип

Описание

name*
string

Имя файла с расширением

content*
string

Содержимое файла в кодировке Base64. Максимальный размер — 100 МБ

message
string

Текст сообщения, отправляемого вместе с файлом

Как подготовить значение для content:

  1. Прочитайте файл в бинарном виде.
  2. Закодируйте содержимое в Base64.
  3. Передайте только строку Base64, без префикса data:*/*;base64,.

Подробнее: Как загружать файлы.

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","fields":{"name":"report.pdf","content":"SGVsbG8gV29ybGQh","message":"Here is the report"}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.File.upload
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"dialogId":"chat5","fields":{"name":"report.pdf","content":"SGVsbG8gV29ybGQh","message":"Here is the report"},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.File.upload
        
try {
          const response = await $b24.callMethod('imbot.v2.File.upload', {
            botId: 456,
            dialogId: 'chat5',
            fields: { name: 'report.pdf', content: 'SGVsbG8gV29ybGQh', message: 'Here is the report' },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.File.upload',
                    [
                        'botId' => 456,
                        'dialogId' => 'chat5',
                        'fields' => [
                            'name' => 'report.pdf',
                            'content' => base64_encode(file_get_contents('/path/to/report.pdf')),
                            'message' => 'Here is the report',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'result: '. print_r($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error: '. $exception->getMessage();
        }
        
BX24.callMethod(
            'imbot.v2.File.upload',
            {
                botId: 456,
                dialogId: 'chat5',
                fields: { name: 'report.pdf', content: btoa('...'), message: 'Here is the report' },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.File.upload',
            [
                'botId' => 456,
                'dialogId' => 'chat5',
                'fields' => [
                    'name' => 'report.pdf',
                    'content' => base64_encode(file_get_contents('/path/to/report.pdf')),
                    'message' => 'Here is the report',
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'File ID: '. $result['result']['file']['id'];
        }

Обработка ответа

HTTP-код: 200

{
            "result": {
                "file": {
                    "id": 138,
                    "chatId": 5,
                    "name": "report.pdf",
                    "extension": "pdf",
                    "size": 35341
                },
                "messageId": 123,
                "chatId": 5,
                "dialogId": "chat5"
            },
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+03:00",
                "date_finish": "2024-10-11T10:00:00+03:00"
            }
        }

Возвращаемые данные

Название
Тип

Описание

result
object

Результат операции

result.file
File

Данные загруженного файла (подробное описание)

result.messageId
integer

ID созданного сообщения с файлом

result.chatId
integer

Числовой ID чата

result.dialogId
string

ID диалога

time
time

Информация о времени выполнения запроса

Поля объекта File

Поле
Тип

Описание

id
integer

Идентификатор файла

chatId
integer

Идентификатор чата

name
string

Имя файла

extension
string

Расширение файла

size
integer

Размер файла в байтах

Полное описание всех полей объектов — на странице Объекты и поля

Обработка ошибок

HTTP-статус: 400, 403

{
            "error": "FILE_TOO_LARGE",
            "error_description": "File too large"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

BOT_TOKEN_NOT_SPECIFIED

Bot token is not specified

Не указан botToken. Обязателен при авторизации через вебхук

BOT_ID_REQUIRED

Bot ID is required

Не указан botId

BOT_NOT_FOUND

Bot not found

Бот не найден

BOT_OWNERSHIP_ERROR

Bot is registered by another application

Бот зарегистрирован другим приложением

FILE_EMPTY

File name or content is empty

Не указано имя или содержимое файла

FILE_INVALID_CONTENT

Invalid base64 content

Невалидный Base64

FILE_FOLDER_ERROR

Failed to get chat folder

Не удалось получить папку чата

FILE_UPLOAD_FAILED

File upload failed

Ошибка загрузки файла

FILE_SEND_FAILED

Failed to send message

Ошибка отправки сообщения

FILE_TOO_LARGE

File is too large

Размер файла превышает 100 МБ

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Обзор методов
Следующая
Получить ссылку для скачивания файла