Загрузить файл в документ note.file.add

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

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

Scope: note

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

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.file.add загружает файл в документ и возвращает объект файла.

Метод не вставляет вложение в содержимое документа автоматически. Он только сохраняет файл и привязывает его к документу.

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

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

Название `тип`	Описание
documentId* `integer`	Идентификатор документа, к которому нужно привязать файл. Идентификатор можно получить методом note.document.tree.list
fileName* `string`	Имя файла с расширением. Допустимые расширения: `png`, `jpg`, `jpeg`, `gif`, `webp`, `svg`, `pdf`, `txt`, `md`, `csv`, `doc`, `docx`, `xls`, `xlsx`, `ppt`, `pptx`, `mp4`, `webm`, `mov`
fileContent* `string`	Бинарное содержимое файла в кодировке Base64. Максимальный размер файла зависит от настройки `main.max_file_size` в Битрикс24. Если она не задана, используется ограничение `25 МиБ (25 * 1024 * 1024 байт)`

Примеры кода

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

Вызов нового api отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.file.add

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":77,"fileName":"diagram.png","fileContent":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.file.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":77,"fileName":"diagram.png","fileContent":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.file.add

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FileAddResult = {
  item: {
    id: number
    documentId: number
    name: string
    size: number
    mimeType: string
    assetType: string
    assetMarkdown: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<FileAddResult>({
    method: 'note.file.add',
    params: {
      documentId: 77,
      fileName: 'diagram.png',
      fileContent: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=',
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('File uploaded:', result.item.id, result.item.assetMarkdown)
  }
} catch (error) {
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addFile() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'note.file.add',
        params: {
          documentId: 77,
          fileName: 'diagram.png',
          fileContent: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('File uploaded:', result.item.id, result.item.assetMarkdown)
    } catch (error) {
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addFile)
</script>

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'note.file.add',
            [
                'documentId' => 77,
                'fileName' => 'diagram.png',
                'fileContent' => 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error uploading file: ' . $e->getMessage();
}

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

BX24.callMethod(
    'note.file.add',
    {
        documentId: 77,
        fileName: 'diagram.png',
        fileContent: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII='
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

require_once('crest.php');

$result = CRest::call(
    'note.file.add',
    [
        'documentId' => 77,
        'fileName' => 'diagram.png',
        'fileContent' => 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII='
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.file.add", b24.Params{
	"documentId":  77,
	"fileName":    "diagram.png",
	"fileContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=",
})
if err != nil {
	return fmt.Errorf("note.file.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID         b24.ID `json:"id"`
	DocumentID b24.ID `json:"documentId"`
	Name       string `json:"name"`
	Size       int    `json:"size"`
	MimeType   string `json:"mimeType"`
	AssetType  string `json:"assetType"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.DocumentID)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 5001,
            "documentId": 77,
            "name": "diagram.png",
            "size": 6321,
            "mimeType": "image/png",
            "assetType": "image",
            "assetMarkdown": "[[image fileId=5001]]"
        }
    },
    "time": {
        "start": 1780392000,
        "finish": 1780392000.284521,
        "duration": 0.28452086448669434,
        "processing": 0.2413930892944336,
        "date_start": "2026-06-16T12:20:00+03:00",
        "date_finish": "2026-06-16T12:20:00+03:00",
        "operating_reset_at": 1780392600,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с результатом загрузки файла
item `object`	Объект загруженного файла
id `integer`	Идентификатор загруженного файла
documentId `integer`	Идентификатор документа, к которому привязан файл
name `string`	Имя файла
size `integer`	Размер файла в байтах
mimeType `string`	MIME-тип файла
assetType `string`	Тип вложения для Markdown-блока
assetMarkdown `string`	Готовый Markdown-блок для вставки файла в документ через note.document.update. Перед вставкой изображения или видео блок можно дополнить параметрами масштаба и выравнивания. Подробнее о параметрах читайте в описании поля `markdown` метода note.document.update
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "invalid base64 payload",
                "field": "fileContent"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

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

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`documentId` `fileName` `fileContent`	Обязательное поле `#FIELD#` не указано	Добавьте указанное поле в тело запроса
`documentId` `fileName` `fileContent`	В поле `#FIELD#` требуется тип данных `#TYPE#` для такого запроса	Убедитесь, что передаваемое значение нужного типа
`fileContent`	Передано некорректное содержимое Base64	Проверьте, что `fileContent` содержит непустую Base64-строку без поврежденных символов
`fileContent`	Не удалось сохранить файл	Повторите запрос позже или проверьте корректность передаваемых данных

Код ошибки: NOTE_FILE_TOO_LARGE

Поле	Описание ошибки	Как исправить
`fileContent`	Размер файла превышает допустимое значение	Уменьшите размер файла или измените настройку `main.max_file_size` в Битрикс24

Код ошибки: NOTE_FILE_TYPE_NOT_ALLOWED

Поле	Описание ошибки	Как исправить
`fileName`	Тип файла не поддерживается	Используйте файл с разрешенным расширением

Ошибки доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	У пользователя нет доступа к модулю База знаний или права редактировать документ

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`documentId`	Документ не найден	Проверьте, что документ существует, не архивирован и не находится в корзине

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

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

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

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

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

Получить данные файла документа

Загрузить файл в документ note.file.add

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

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

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

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

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

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

Ошибки валидации запросаОшибки валидации запроса

Ошибки доступаОшибки доступа

Ошибка отсутствия объектаОшибка отсутствия объекта

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

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

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

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

Примеры кода

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

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

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

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

Ошибки валидации запроса

Ошибки доступа

Ошибка отсутствия объекта

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

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