Загрузить и привязать изображение к блоку landing.block.uploadfile

Scope: landing

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

Метод landing.block.uploadfile загружает изображение и привязывает его к указанному блоку.

В ответе метод возвращает идентификатор файла и ссылку на него в поле src. Само изображение метод в блок не подставляет. Это значит, что после загрузки файл уже есть, но в содержимом блока он еще не показан. Обычно для этого после landing.block.uploadfile вызывают landing.block.updatenodes.

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

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

Название
тип

Описание

block*
integer

Идентификатор блока, к которому нужно привязать изображение.

Метод принимает идентификатор любого существующего блока.

Идентификатор блока можно получить методом landing.block.getlist

Если изображение нужно добавить в черновик опубликованной страницы, используйте идентификатор блока из черновика. Обычно для этого вызывают landing.block.getlist с параметром params.edit_mode = 1

picture*
string | string[]

Изображение для загрузки.

Метод принимает только изображения. Поддерживаются два формата:

  • URL изображения,
  • массив ["имя_файла.png", "base64_контент"].

Для массива имя файла должно содержать расширение. Во втором элементе массива передавайте только содержимое Base64 без префикса data:image/...;base64,.

При сохранении имя файла может измениться. Кириллические буквы метод транслитерирует, а пробелы и круглые скобки заменяет на _.

Подробнее о подготовке Base64: Как загрузить файлы

ext
string

Расширение файла для загрузки по URL, если его нельзя точно определить по адресу.

Параметр учитывается только для picture, переданного как URL. Укажите в нем расширение файла изображения.

Если параметр не передан, расширение определяется автоматически. Для массива picture расширение берется из имени файла

params
object

Дополнительные параметры обработки изображения (подробное описание).

Если параметр не передан, изображение сохраняется без изменения размера

temp
boolean | integer

Если значение приводится к true, файл помечается как временный.

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

Параметр params

Название
тип

Описание

width
integer

Целевая ширина изображения в пикселях.

Изменение размера выполняется только если одновременно передан height

height
integer

Целевая высота изображения в пикселях.

Изменение размера выполняется только если одновременно передан width

resize_type
integer

Режим изменения размера.

Возможные значения:
0 — вписать изображение в указанные размеры с сохранением пропорций,
1 — изменить размер пропорционально по большей стороне,
2 — привести изображение к точным размерам, при необходимости обрезав его.

По умолчанию — 1. Параметр применяется только к растровым изображениям

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "block": 39556,
            "picture": ["banner.png", "**base64_image_content**"],
            "params": {
              "width": 1200,
              "height": 675
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.uploadfile.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "block": 39556,
            "picture": ["banner.png", "**base64_image_content**"],
            "params": {
              "width": 1200,
              "height": 675
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.uploadfile.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.block.uploadfile',
        		{
        			block: 39556,
        			picture: ['banner.png', '**base64_image_content**'],
        			params: {
        				width: 1200,
        				height: 675
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.block.uploadfile',
                    [
                        'block' => 39556,
                        'picture' => ['banner.png', '**base64_image_content**'],
                        'params' => [
                            'width' => 1200,
                            'height' => 675,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error uploading image: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.block.uploadfile',
            {
                block: 39556,
                picture: ['banner.png', '**base64_image_content**'],
                params: {
                    width: 1200,
                    height: 675
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.block.uploadfile',
            [
                'block' => 39556,
                'picture' => ['banner.png', '**base64_image_content**'],
                'params' => [
                    'width' => 1200,
                    'height' => 675,
                ],
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

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

HTTP-статус: 200

{
            "result": {
                "id": 33873,
                "src": "https://cdn-ru.bitrix24.ru/b13743910/landing/fda/fda6c41d4b2b4f4d672601bd48c6aff1/nature.jpg"
            },
            "time": {
                "start": 1774523909,
                "finish": 1774523910.101491,
                "duration": 1.1014909744262695,
                "processing": 1,
                "date_start": "2026-03-26T14:18:29+03:00",
                "date_finish": "2026-03-26T14:18:30+03:00",
                "operating_reset_at": 1774524509,
                "operating": 0.30655694007873535
            }
        }

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

Название
тип

Описание

result
object

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

time
time

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

Объект result

Название
тип

Описание

id
integer

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

src
string

Адрес загруженного файла.

В зависимости от окружения может вернуться относительный путь или полный URL

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

HTTP-статус: 400

{
            "error": "FILE_ERROR",
            "error_description": "Ошибка загрузки файла. Возможно, файл не является графическим."
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр block или picture

BLOCK_NOT_FOUND

Блок с идентификатором block не найден или недоступен. Ошибка также возвращается, если по этому идентификатору нельзя определить страницу

FILE_ERROR

Не удалось загрузить изображение. Ошибка возвращается, если файл не скачался по URL, не прочитался из Base64, не прошел проверку как изображение, SVG не разрешен на портале или файл не удалось сохранить

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

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

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

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

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