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

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: im

Кто может выполнять метод: пользователь с доступом к чату

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

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

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

Название `тип`	Описание
dialogId* `string`	ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}`
fields* `object`	Объект с параметрами файла и сообщения (подробное описание)

Параметр fields

Название `тип`	Описание
name* `string`	Имя файла с расширением
content* `string`	Содержимое файла в кодировке Base64. Максимальный размер — 100 МБ
message `string`	Текст сообщения, отправляемого вместе с файлом

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

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

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"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**/im.v2.File.upload

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"dialogId":"chat5","fields":{"name":"report.pdf","content":"SGVsbG8gV29ybGQh","message":"Here is the report"},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.v2.File.upload

try {
          const response = await $b24.callMethod('im.v2.File.upload', {
            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(
                    'im.v2.File.upload',
                    [
                        '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(
            'im.v2.File.upload',
            {
                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(
            'im.v2.File.upload',
            [
                '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'];
        }

// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "im.v2.File.upload", b24.Params{
        	"dialogId": "chat5",
        	"fields": b24.Params{
        		"name":    "report.pdf",
        		"content": "SGVsbG8gV29ybGQh",
        		"message": "Here is the report",
        	},
        })
        if err != nil {
        	return fmt.Errorf("im.v2.File.upload: %w", err)
        }
        
        var item struct {
        	DialogID  string `json:"dialogId"`
        	ChatID    b24.ID `json:"chatId"`
        	MessageID b24.ID `json:"messageId"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("разбор ответа: %w", err)
        }
        fmt.Println(item.DialogID, item.ChatID)

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

HTTP-статус: 200

{
            "result": {
                "file": {
                    "id": 9817,
                    "chatId": 4415,
                    "date": "2026-08-11T15:28:50+03:00",
                    "type": "file",
                    "name": "report.pdf",
                    "extension": "pdf",
                    "size": 35341,
                    "image": false,
                    "status": "done",
                    "progress": 100,
                    "authorId": 1,
                    "authorName": "Иван Иванов",
                    "urlPreview": "",
                    "urlShow": "https://mysite.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=9817&exact=N&fileName=report.pdf",
                    "urlDownload": "https://mysite.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=9817&exact=N&fileName=report.pdf",
                    "viewerAttrs": {
                        "viewer": "",
                        "viewerType": "code",
                        "src": "https://mysite.bitrix24.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=9817&exact=N&fileName=report.pdf",
                        "objectId": "9817",
                        "viewerGroupBy": "4415",
                        "imChatId": 4415,
                        "title": "report.pdf",
                        "unifiedLink": "https://mysite.bitrix24.ru/file/5tqNA6utERA5MIWnKpFX",
                        "actions": "[{\"type\":\"download\"}]"
                    },
                    "mediaUrl": {
                        "preview": {
                            "250": ""
                        }
                    },
                    "isTranscribable": false,
                    "isVideoNote": false,
                    "isVoiceNote": false
                },
                "messageId": 38655,
                "chatId": 4415,
                "dialogId": "chat4415"
            },
            "time": {
                "start": 1786451330,
                "finish": 1786451330.233862,
                "duration": 0.23386192321777344,
                "processing": 0,
                "date_start": "2026-08-11T15:28:50+03:00",
                "date_finish": "2026-08-11T15:28:50+03:00",
                "operating_reset_at": 1786451790,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Результат операции
result.dialogId `string`	Идентификатор диалога
result.chatId `integer`	Числовой идентификатор чата
result.messageId `integer`	Идентификатор созданного сообщения с файлом
result.file `File`	Данные загруженного файла (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект File

Название `тип`	Описание
id `integer`	Идентификатор файла на Диске
chatId `integer`	Идентификатор чата
date `datetime`	Дата загрузки файла
type `string`	Тип файла: `file`, `image`, `video`, `audio`
name `string`	Имя файла
extension `string`	Расширение файла
size `integer`	Размер файла в байтах
image `boolean`	`false` для обычного файла. Для изображения — объект с шириной и высотой
status `string`	Статус загрузки, например `done`
progress `integer`	Прогресс загрузки в процентах
authorId `integer`	Идентификатор пользователя, который загрузил файл
authorName `string`	Имя пользователя, который загрузил файл
urlPreview `string`	Ссылка на превью файла или пустая строка
urlShow `string`	Ссылка для просмотра файла
urlDownload `string`	Ссылка для скачивания файла
viewerAttrs `object`	Атрибуты для встроенного просмотрщика Битрикс24
mediaUrl `object`	Ссылки на превью медиафайла по размерам
isTranscribable `boolean`	Признак файла, который можно расшифровать в текст
isVideoNote `boolean`	Признак видеосообщения
isVoiceNote `boolean`	Признак голосового сообщения

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

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

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

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`FILE_EMPTY`	File name and content are required	Не передано имя или содержимое файла
`FILE_INVALID_CONTENT`	Invalid base64 content	Содержимое файла — не строка Base64
`CHAT_NOT_FOUND`	CHAT_NOT_FOUND	Чат из `dialogId` не найден
`FOLDER_ERROR`	Failed to get chat folder	Не удалось получить папку чата
`UPLOAD_FAILED`	File upload failed	Ошибка загрузки файла
`SEND_FAILED`	Failed to send message	Ошибка отправки сообщения
`FILE_TOO_LARGE`	File is too large	Размер файла превышает 100 МБ
`ACCESS_DENIED`	Access denied	Нет доступа к чату

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

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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

Обзор методов

Получить ссылку для скачивания файла

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

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

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

Объект FileОбъект File

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

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

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

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