Загрузить новый файл в указанную папку disk.folder.uploadfile

Scope: disk

Кто может выполнять метод: пользователь с правом «Добавление» для нужной папки

Метод disk.folder.uploadfile загружает новый файл в указанную папку.

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

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

Название
тип

Описание

id*
integer

Идентификатор папки, в которую нужно загрузить файл.

Идентификатор можно получить с помощью метода disk.storage.getchildren, если папка находится в корне хранилища, и с помощью метода disk.folder.getchildren, если папка находится в другой папке

data*
array

Массив с полем NAME, где NAME — имя файла.

Необязателен, если файл загружается не напрямую, а через URL. Пример загрузки файла через URL ниже

fileContent
array

Массив из имени файла и строки с Base64.

Если параметр не передан, метод не загружает файл, а возвращает URL для загрузки UploadUrl и имя поля формы field

rights
array

Массив прав доступа на загружаемый файл в формате {"TASK_ID": 42, "ACCESS_CODE": "U35"}, где

  • TASK_ID — идентификатор уровня доступа
  • ACCESS_CODE — код доступа, состоящий из буквенного кода пользователя или отдела и идентификатора

Категории пользователей:

  • U — пользователь
  • * — все пользователи
  • D — все сотрудники отдела
  • DR — все сотрудники отдела с подотделами

Список доступных идентификаторов TASK_ID для установки прав можно получить методом disk.rights.getTasks

generateUniqueName
boolean

Генерация уникального имени файла, если файл с таким именем уже существует. Например, file (1).docx.

Возможные значения:

  • true — генерировать
  • false — не генерировать

По умолчанию — false

Примеры кода

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

Прямая загрузка файла

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8930,"data":{"NAME":"test.png"},"fileContent":["test.png","iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII="],"generateUniqueName":true,"rights":[{"TASK_ID":75,"ACCESS_CODE":"U1271"}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.uploadfile
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8930,"data":{"NAME":"test.png"},"fileContent":["test.png","iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII="],"generateUniqueName":true,"rights":[{"TASK_ID":75,"ACCESS_CODE":"U1271"}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.folder.uploadfile
        
try {
            const response = await $b24.callMethod(
                'disk.folder.uploadfile',
                {
                    id: 8930,
                    data: {
                        NAME: 'test.png',
                    },
                    fileContent: [
                        'test.png',
                        'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII=',
                    ],
                    generateUniqueName: true,
                    rights: [
                        {
                            TASK_ID: 75,
                            ACCESS_CODE: 'U1271'
                        }
                    ]
                }
            );
        
            const result = response.getData().result;
            console.log(result);
            processResult(result);
        } catch (error) {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.folder.uploadfile',
                    [
                        'id' => 8930,
                        'data' => [
                            'NAME' => 'test.png'
                        ],
                        'fileContent' => [
                            'test.png',
                            'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII='
                        ],
                        'generateUniqueName' => true,
                        'rights' => [
                            [
                                'TASK_ID' => 75,
                                'ACCESS_CODE' => 'U1271'
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error uploading file: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.folder.uploadfile",
            {
                id: 8930,
                data: {
                    NAME: "test.png"
                },
                fileContent: [
                'test.png',
                'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII=',
                ],
                generateUniqueName: true,
                rights: [
                    {
                        TASK_ID: 75,
                        ACCESS_CODE: 'U1271'
                    }
                ]
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'disk.folder.uploadfile',
            [
                'id' => 8930,
                'data' => [
                    'NAME' => 'test.png'
                ],
                'fileContent' => [
                    'test.png',
                    'iVBORw0KGgoAAAANSUhEUgAAAD4AAABDCAYAAADEfbZbAAAACXBIWXMAABJ0AAASdAHeZh94...rk5CYII='
                ],
                'generateUniqueName' => true,
                'rights' => [
                    [
                        'TASK_ID' => 75,
                        'ACCESS_CODE' => 'U1271'
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Загрузка файла через URL

  1. Вызовите метод и передайте только ID папки.

    curl -X POST \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -d '{"id":8930}' \
            https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.uploadfile
            
    curl -X POST \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -d '{"id":8930,"auth":"**put_access_token_here**"}' \
            https://**put_your_bitrix24_address**/rest/disk.folder.uploadfile
            
    try
            {
                const response = await $b24.callMethod(
                    'disk.folder.uploadfile',
                    {
                        id: 8930,
                    }
                );
                
                const result = response.getData().result;
                console.log(result);
                
                processResult(result);
            }
            catch( error )
            {
                console.error('Error:', error);
            }
            
    try {
                $response = $b24Service
                    ->core
                    ->call(
                        'disk.folder.uploadfile',
                        [
                            'id' => 8930
                        ]
                    );
            
                $result = $response
                    ->getResponseData()
                    ->getResult();
            
                echo 'Success: ' . print_r($result, true);
                processData($result);
            
            } catch (Throwable $e) {
                error_log($e->getMessage());
                echo 'Error uploading file: ' . $e->getMessage();
            }
            
    BX24.callMethod(
                "disk.folder.uploadfile",
                {
                    id: 8930
                },
                function (result)
                {
                    if (result.error())
                        console.error(result.error());
                    else
                        console.dir(result.data());
                }
            );
            
    require_once('crest.php');
            
            $result = CRest::call(
                'disk.folder.uploadfile',
                [
                    'id' => 8930
                ]
            );
            
            echo '<PRE>';
            print_r($result);
            echo '</PRE>';
            
  2. В ответ вы получите URL для загрузки UploadUrl и имя поля формы field.

    "result": {
                    "field": "file",
                    "uploadUrl": "https://test.bitrix24.ru/rest/upload.json?auth=929b78690000071b006e2cf2000004f5000007dde54ef79d3b6e5c447d8f8a714563bd&token=disk%7CaWQ9ODkzMCZnZW5lcmF0ZVVuaXF1ZU5hbWU9MCZfPU4zS0pqUFJiVDFSengzUmpUaTVPcGM4R1VQTlFkTWU0%7CInVwbG9hZHxkaXNrfGFXUTlPRGt6TUNablpXNWxjbUYwWlZWdWFYRjFaVTVoYldVOU1DWmZQVTR6UzBwcVVGSmlWREZTZW5nelVtcFVhVFZQY0dNNFIxVlFUbEZrVFdVMHw5MjliNzg2OTAwMDAwNzFiMDA2ZTJjZjIwMDAwMDRmNTAwMDAwN2RkZTU0ZWY3OWQzYjZlNWM0NDdkOGY4YTcxNDU2M2JkIg%3D%3D.OHwSxVni%2FKX9Pw%2FyMzpfR974ImX5bC0sigTqA0UTCp8%3D"
                    },
                "time": {
                    "start": 1769511710,
                    "finish": 1769511710.411701,
                    "duration": 0.411700963973999,
                    "processing": 0,
                    "date_start": "2026-01-27T14:01:50+03:00",
                    "date_finish": "2026-01-27T14:01:50+03:00",
                    "operating_reset_at": 1769512310,
                    "operating": 0
                }
            
  3. Отправьте файл на полученный адрес UploadUrl с помощью POST-запроса, используя тип multipart/form-data. Имя поля для файла внутри этого запроса должно совпадать со значением параметра field из ответа.

    http --form POST "https://test.bitrix24.ru/rest/upload.json?auth=929b78690000071b006e2cf2000004f5000007dde54ef79d3b6e5c447d8f8a714563bd&token=disk%7CaWQ9ODkzMCZnZW5lcmF0ZVVuaXF1ZU5hbWU9MCZfPU4zS0pqUFJiVDFSengzUmpUaTVPcGM4R1VQTlFkTWU0%7CInVwbG9hZHxkaXNrfGFXUTlPRGt6TUNablpXNWxjbUYwWlZWdWFYRjFaVTVoYldVOU1DWmZQVTR6UzBwcVVGSmlWREZTZW5nelVtcFVhVFZQY0dNNFIxVlFUbEZrVFdVMHw5MjliNzg2OTAwMDAwNzFiMDA2ZTJjZjIwMDAwMDRmNTAwMDAwN2RkZTU0ZWY3OWQzYjZlNWM0NDdkOGY4YTcxNDU2M2JkIg%3D%3D.OHwSxVni%2FKX9Pw%2FyMzpfR974ImX5bC0sigTqA0UTCp8%3D" file@/path/to/file.png
            
  4. В случае успеха сервер вернет массив с данными о загруженном файле.

Загрузка файла через URL на PHP

<?php
        require_once (__DIR__.'/crest.php');
        
        $path = __DIR__ . '/pic.jpg';
        $folderId = 1;
        
        $result = [];
        if (file_exists($path))
        {
            $file = CRest::call(
                'disk.folder.uploadfile',
                [
                    'id' => $folderId,
                ]
            );
            if (!empty($file['result']['uploadUrl']))
            {
                $info = pathinfo($path);
                if ($info['basename'])
                {
                    $delimiter = '-------------' . uniqid('', true);
                    $name = $info['basename'];
                    $mime = mime_content_type($path);
                    $content = file_get_contents($path);
        
                    $body = '--' . $delimiter. "\r\n";
                    $body .= 'Content-Disposition: form-data; name="file"';
                    $body .= '; filename="' . $name . '"' . "\r\n";
                    $body .= 'Content-Type: ' . $mime . "\r\n\r\n";
                    $body .= $content . "\r\n";
                    $body .= "--" . $delimiter . "--\r\n";
        
                    $ch = curl_init();
                    curl_setopt($ch, CURLOPT_URL, $file['result']['uploadUrl']);
                    curl_setopt($ch, CURLOPT_POST, 1);
                    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                    curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
                    curl_setopt(
                        $ch,
                        CURLOPT_HTTPHEADER,
                        [
                            'Content-Type: multipart/form-data; boundary=' . $delimiter,
                            'Content-Length: ' . strlen($body),
                        ]
                    );
                    $out = curl_exec($ch);
                    try
                    {
                        $result = json_decode($out, true, 512, JSON_THROW_ON_ERROR);
                    }
                    catch (JsonException $e)
                    {
                        $result = [
                            'error' => $e->getMessage(),
                        ];
                    }
                }
            }
        }
        
        echo '<pre>';
            print_r($result);
        echo '</pre>';
        ?>
        

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

HTTP-статус: 200

{
            "result": {
                "ID": 9011,
                "NAME": "test.png",
                "CODE": null,
                "STORAGE_ID": "1357",
                "TYPE": "file",
                "PARENT_ID": "8930",
                "DELETED_TYPE": 0,
                "GLOBAL_CONTENT_VERSION": 1,
                "FILE_ID": 32877,
                "SIZE": "1679",
                "CREATE_TIME": "2026-01-27T13:06:55+03:00",
                "UPDATE_TIME": "2026-01-27T13:06:55+03:00",
                "DELETE_TIME": null,
                "CREATED_BY": "1269",
                "UPDATED_BY": "1269",
                "DELETED_BY": null,
                "DOWNLOAD_URL": "https://test.bitrix24.ru/rest/download.json?auth=929b78690000071b006e2cf2000004f5000007dde54ef79d3b6e5c447d8f8a714563bd&token=disk%7CaWQ9OTAxMSZfPUFKQTNyWWVLZkxVdEw0VDRjY1QyOGpyN1NqYXZneFRI%7CImRvd25sb2FkfGRpc2t8YVdROU9UQXhNU1pmUFVGS1FUTnlXV1ZMWmt4VmRFdzBWRFJqWTFReU9HcHlOMU5xWVhabmVGUkl8OTI5Yjc4NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDdkZGU1NGVmNzlkM2I2ZTVjNDQ3ZDhmOGE3MTQ1NjNiZCI%3D.XX%2BUFpxsl2eoLuCwolEaMKsrAJ5IIpIPmzg1j6QOuE0%3D",
                "DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/file/Папка/Папка в папке/test.png"
            },
            "time": {
                "start": 1769508415,
                "finish": 1769508416.040339,
                "duration": 1.0403389930725098,
                "processing": 1,
                "date_start": "2026-01-27T13:06:55+03:00",
                "date_finish": "2026-01-27T13:06:56+03:00",
                "operating_reset_at": 1769509015,
                "operating": 0.7169051170349121
            }
        }
        

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

Название
тип

Описание

result
array

Массив с полями файла

ID
integer

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

NAME
string

Имя файла

CODE
string

Символьный код файла

STORAGE_ID
integer

Идентификатор хранилища, в котором находится файл

TYPE
enum

Тип объекта

PARENT_ID
integer

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

DELETED_TYPE
enum

Статус удаления объекта. Возможные значения:

  • 0 — не удален
  • 3 — в корзине
  • 4 — удален вместе с родительской папкой

GLOBAL_CONTENT_VERSION
integer

Инкрементальный счетчик версии файла

FILE_ID
integer

Внутреннее значение идентификатора файла

SIZE
integer

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

CREATE_TIME
datetime

Дата и время создания файла

UPDATE_TIME
datetime

Дата и время последнего обновления файла

DELETE_TIME
datetime

Дата и время переноса файла в корзину

CREATED_BY
integer

Идентификатор пользователя, создавшего файл

UPDATED_BY
integer

Идентификатор пользователя, внесшего последнее изменение

DELETED_BY
integer

Идентификатор пользователя, удалившего файл

DOWNLOAD_URL
string

Ссылка для скачивания файла

DETAIL_URL
string

Ссылка для открытия файла в интерфейсе

time
time

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

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

HTTP-статус: 400

{
            "error":"ERROR_NOT_FOUND",
            "error_description":"Could not find entity with id `X`"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

ERROR_ARGUMENT

Invalid value of parameter

Не указан обязательный параметр id

ERROR_NOT_FOUND

Could not find entity with id X

Папка с указанным id не найдена

DISK_BASE_SERVICE_22001

Error: required parameter NAME (DISK_BASE_SERVICE_22001)

Не указан обязательный параметр NAME в массиве data

ERROR_COULD_NOT_SAVE_FILE

Could not save file

Не удалось сохранить файл. Проверьте свободное место на Диске и корректность кодировки данных

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

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

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

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

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