Добавить файл в чат im.disk.file.commit

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

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

Scope: im

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

Устаревший метод

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

Метод im.disk.file.commit добавляет файл в чат.

Для добавления файла укажите:

один из параметров идентификатора чата — CHAT_ID или DIALOG_ID
один из параметров идентификатора файла — FILE_ID или UPLOAD_ID

Если передать несколько параметров одновременно, метод обрабатывает только первый.

Получить идентификатор нового файла можно после загрузки методом disk.folder.upload.file. Получить идентификатор существующего файла можно методом:

disk.storage.getchildren — если файл находится в корне хранилища
disk.folder.getchildren — если файл находится в папке

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

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

Название `тип`	Описание
CHAT_ID* `integer`	Идентификатор чата. Обязателен, если не передан `DIALOG_ID`
DIALOG_ID* `string`	Идентификатор диалога в формате: `chatXXX` — чат `sgXXX` — чат группы или проекта `XXX` — идентификатор пользователя личного чата Обязателен, если не передан `CHAT_ID`
FILE_ID* `integer`	Идентификатор файла на Диске. Можно передать массив. Обязателен, если не передан `UPLOAD_ID`
UPLOAD_ID* `integer`	Идентификатор файла на Диске. Можно передать массив. Поддерживает дополнительный параметр `AS_FILE`, который позволяет отправить изображение без сжатия, в виде файла. Обязателен, если не передан `FILE_ID`
MESSAGE `string`	Текст сообщения с файлом
SILENT_MODE `string`	Параметр для чата Открытых линий Возможные значения: `Y` — отправлять уведомление клиенту `N` — не отправлять уведомление клиенту
AS_FILE `string`	Отправить как файл. Только для `UPLOAD_ID`. Возможные значения: `Y` — да `N` — нет

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CHAT_ID":1489,"FILE_ID":[5249,5250],"MESSAGE":"Документы по проекту"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.disk.file.commit

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CHAT_ID":1489,"FILE_ID":[5249,5250],"MESSAGE":"Документы по проекту","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.disk.file.commit

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FileUploadItem = {
  id: number
  chatId: number
  name: string
  extension: string
  size: number
  status: string
  authorId: number
  authorName: string
  urlPreview: string
  urlShow: string
  urlDownload: string
  isTranscribable: boolean
  isVideoNote: boolean
  isVoiceNote: boolean
}

type FileModelItem = {
  id: number
  name: string
  storageId: number
  size: number
  etag: string
  links: {
    download: string
    showInGrid: string
    preview: string
  }
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type ImDiskFileCommitResult = {
  FILES: Record<string, FileUploadItem>
  DISK_ID: string[]
  FILE_MODELS: Record<string, FileModelItem>
  MESSAGE_ID: number
}

try {
  const response = await $b24.actions.v2.call.make<ImDiskFileCommitResult>({
    method: 'im.disk.file.commit',
    params: {
      CHAT_ID: 1489,
      FILE_ID: [5249, 5250],
      MESSAGE: 'Project documents',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.MESSAGE_ID, result.DISK_ID, result.FILES)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function commitFileToChat() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.disk.file.commit',
        params: {
          CHAT_ID: 1489,
          FILE_ID: [5249, 5250],
          MESSAGE: 'Project documents',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.MESSAGE_ID, result.DISK_ID, result.FILES)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.disk.file.commit(
        chat_id=1489,
        file_id=[
            5249,
            5250,
        ],
        message="Документы по проекту",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'im.disk.file.commit',
            [
                'CHAT_ID' => 1489,
                'FILE_ID' => [5249, 5250],
                'MESSAGE' => 'Документы по проекту',
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

BX24.callMethod(
    'im.disk.file.commit',
    {
        CHAT_ID: 1489,
        FILE_ID: [5249, 5250],
        MESSAGE: 'Документы по проекту',
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'im.disk.file.commit',
    [
        'CHAT_ID' => 1489,
        'FILE_ID' => [5249, 5250],
        'MESSAGE' => 'Документы по проекту',
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.disk.file.commit", b24.Params{
	"CHAT_ID": 1489,
	"FILE_ID": []int{5249, 5250},
	"MESSAGE": "Документы по проекту",
})
if err != nil {
	return fmt.Errorf("im.disk.file.commit: %w", err)
}

var item struct {
	MessageID b24.ID `json:"MESSAGE_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.MessageID)

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

HTTP-статус: 200

{
    "result": {
        "FILES": {
            "upload5249": {
                "id": 5249,
                "chatId": 1489,
                "date": {},
                "type": "file",
                "name": "image.png",
                "extension": "png",
                "size": 2144,
                "image": {
                    "height": 61,
                    "width": 72
                },
                "status": "done",
                "progress": 100,
                "authorId": 503,
                "authorName": "Иван Иванов",
                "urlPreview": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5249&exact=N&_esd=hpbccd%2FZFlCVMvT8%2FoXYU%2FfMrCjiXqxIAf6V4Sv1rR0euQRiW7%2BsdhF7n1QGRL8ZBBmpuiVaX9sY2NbsyigTzBiykXGbFEbXUAmoPO8IvcdVkdoD5n6CJHZG9DZ0DRpH6i5goVbMdjo%3D&fileName=image.png",
                "urlShow": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.showImage&SITE_ID=s1&humanRE=1&fileId=5249&width=1280&height=1280&signature=9f56cfa3412e55679012a6c3bef9ff391f1fc7becf6dc42bea2b8d68656934ce&exact=N&_esd=hpbccd%2FZFlCVMvT8%2FoXYU%2FfMrCjiXqxIAf6V4Sv1rR0euQRiW7%2BsdhF7n1QGRL8ZBBmpuiVaX9sY2NbsyigTzBiykXGbFEbXUAmoPO8IvcdVkdoD5n6CJHZG9DZ0DRpH6i5goVbMdjo%3D&fileName=image.png",
                "urlDownload": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5249&exact=N&_esd=hpbccd%2FZFlCVMvT8%2FoXYU%2FfMrCjiXqxIAf6V4Sv1rR0euQRiW7%2BsdhF7n1QGRL8ZBBmpuiVaX9sY2NbsyigTzBiykXGbFEbXUAmoPO8IvcdVkdoD5n6CJHZG9DZ0DRpH6i5goVbMdjo%3D&fileName=image.png",
                "viewerAttrs": {
                    "viewer": "",
                    "viewerType": "image",
                    "src": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5249&exact=N&_esd=hpbccd%2FZFlCVMvT8%2FoXYU%2FfMrCjiXqxIAf6V4Sv1rR0euQRiW7%2BsdhF7n1QGRL8ZBBmpuiVaX9sY2NbsyigTzBiykXGbFEbXUAmoPO8IvcdVkdoD5n6CJHZG9DZ0DRpH6i5goVbMdjo%3D&fileName=image.png",
                    "viewerResized": "",
                    "objectId": "5249",
                    "viewerGroupBy": "1489",
                    "imChatId": 1489,
                    "title": "image.png",
                    "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"5249\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]"
                },
                "mediaUrl": {
                    "preview": {
                        "250": "https://mysite.ru/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=5249&exact=N&_esd=hpbccd%2FZFlCVMvT8%2FoXYU%2FfMrCjiXqxIAf6V4Sv1rR0euQRiW7%2BsdhF7n1QGRL8ZBBmpuiVaX9sY2NbsyigTzBiykXGbFEbXUAmoPO8IvcdVkdoD5n6CJHZG9DZ0DRpH6i5goVbMdjo%3D&fileName=image.png"
                    }
                },
                "isTranscribable": false,
                "isVideoNote": false,
                "isVoiceNote": false
            }
        },
        "DISK_ID": [
            "5249"
        ],
        "FILE_MODELS": {
            "upload5249": {
                "id": 5249,
                "name": "image.png",
                "createTime": {},
                "updateTime": {},
                "deleteTime": null,
                "code": "media_original",
                "xmlId": null,
                "storageId": 663,
                "realObjectId": 5249,
                "parentId": 4821,
                "deletedType": 0,
                "createdBy": "503",
                "updatedBy": "503",
                "deletedBy": "0",
                "uniqueCode": "k7lj3sQxTRWSi6K93Vyh",
                "typeFile": 2,
                "globalContentVersion": 2,
                "fileId": 57077,
                "size": 2144,
                "etag": "73c045036a9e96943fa57316371655c2",
                "links": {
                    "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=5249",
                    "showInGrid": "/bitrix/tools/disk/focus.php?objectId=5249&action=showObjectInGrid&ncc=1",
                    "preview": "/bitrix/services/main/ajax.php?action=disk.api.file.showImage&SITE_ID=s1&humanRE=1&width=640&height=640&signature=8e152b3f4820b07a3f8ea79a6de60b0ae5a82a57467d08d1e8a8a399afb0330f&fileId=5249"
                }
            }
        },
        "MESSAGE_ID": 84779
    },
    "time": {
        "start": 1772451339,
        "finish": 1772451339.658828,
        "duration": 0.6588280200958252,
        "processing": 0,
        "date_start": "2026-03-02T14:35:39+03:00",
        "date_finish": "2026-03-02T14:35:39+03:00",
        "operating_reset_at": 1772451939,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Корневой объект результата (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result-item

Название `тип`	Описание
FILES `object`	Данные добавленных файлов (подробное описание)
DISK_ID `array`	Массив идентификаторов файлов на Диске
FILE_MODELS `object`	Модели добавленных файлов на Диске (подробное описание)
MESSAGE_ID `integer`	Идентификатор сообщения с файлами

Объект FILES

Название `тип`	Описание
upload{id} `object`	Объект файла, где `id` — идентификатор файла загрузки (подробное описание)

Объект FILES.upload{id}

Название `тип`	Описание
id `integer`	Идентификатор файла на Диске
chatId `integer`	Идентификатор чата
date `object`	Дата создания файла
type `string`	Тип элемента
name `string`	Имя файла
extension `string`	Расширение файла
size `integer`	Размер файла в байтах
image `object`	Параметры изображения (подробное описание)
status `string`	Статус обработки файла
progress `integer`	Прогресс обработки файла в процентах
authorId `integer`	Идентификатор автора файла
authorName `string`	Имя автора файла
urlPreview `string`	Ссылка на превью файла
urlShow `string`	Ссылка на просмотр файла
urlDownload `string`	Ссылка на скачивание файла
viewerAttrs `object`	Параметры просмотрщика файла (подробное описание)
mediaUrl `object`	Ссылки на медиафайл (подробное описание)
isTranscribable `boolean`	Доступна ли расшифровка файла
isVideoNote `boolean`	Является ли файл видеосообщением
isVoiceNote `boolean`	Является ли файл голосовым сообщением

Объект image

Название `тип`	Описание
height `integer`	Высота изображения
width `integer`	Ширина изображения

Объект viewerAttrs

Название `тип`	Описание
viewer `string`	Идентификатор просмотрщика
viewerType `string`	Тип просмотрщика
src `string`	Источник файла для просмотрщика
viewerResized `string`	Источник уменьшенной версии файла
objectId `string`	Идентификатор объекта в просмотрщике
viewerGroupBy `string`	Идентификатор группы просмотра
imChatId `integer`	Идентификатор чата для просмотрщика
title `string`	Заголовок в просмотрщике
actions `string`	Список действий в просмотрщике в формате JSON-строки

Объект mediaUrl

Название `тип`	Описание
preview `object`	Набор ссылок на превью файла по размерам (подробное описание)

Объект mediaUrl.preview

Название `тип`	Описание
250 `string`	Ссылка на превью шириной 250 px

Объект FILE_MODELS

Название `тип`	Описание
upload{id} `object`	Объект модели файла, где `id` — идентификатор файла загрузки (подробное описание)

Объект FILE_MODELS.upload{id}

Название `тип`	Описание
id `integer`	Идентификатор файла на Диске
name `string`	Имя файла
createTime `object`	Дата создания файла
updateTime `object`	Дата обновления файла
deleteTime `string`	Дата удаления файла, может быть `null`
code `string`	Код типа файла
xmlId `string`	Внешний идентификатор, может быть `null`
storageId `integer`	Идентификатор хранилища
realObjectId `integer`	Идентификатор реального объекта
parentId `integer`	Идентификатор родительской папки
deletedType `integer`	Тип удаления
createdBy `string`	Идентификатор автора создания
updatedBy `string`	Идентификатор автора обновления
deletedBy `string`	Идентификатор автора удаления
uniqueCode `string`	Уникальный код файла
typeFile `integer`	Числовой код типа файла
globalContentVersion `integer`	Глобальная версия контента
fileId `integer`	Идентификатор связанного файла
size `integer`	Размер файла в байтах
etag `string`	ETag файла
links `object`	Ссылки для работы с файлом (подробное описание)

Объект links

Название `тип`	Описание
download `string`	Ссылка на скачивание файла
showInGrid `string`	Ссылка на показ файла в сетке
preview `string`	Ссылка на превью файла

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

HTTP-статус: 400

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID can't be empty"
}

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

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

Статус	Код	Описание	Значение
`400`	`CHAT_ID_EMPTY`	Chat ID can't be empty	Возможные причины: не передан один из обязательных параметров `CHAT_ID` или `DIALOG_ID` передан пустой `CHAT_ID`
`400`	`DIALOG_ID_EMPTY`	Dialog ID can't be empty	Передан пустой или некорректный `DIALOG_ID`
`400`	`FILES_ERROR`	List of files in not specified	Не передан один из обязательных параметров `FILE_ID` или `UPLOAD_ID`
`400`	`SAVE_ERROR`	Error during saving file to chat	Возможные причины: передан пустым `FILE_ID` или `UPLOAD_ID` переданы несуществующие идентификаторы файлов
`403`	`ACCESS_ERROR`	You do not have access to the specified dialog	Недостаточно прав на просмотр диалога или передан несуществующий диалог

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

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

Сохранить файл на свой диск

Добавить файл в чат im.disk.file.commit

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

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

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

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

Объект result-itemОбъект result-item

Объект FILESОбъект FILES

Объект FILES.upload{id}Объект FILES.upload{id}

Объект imageОбъект image

Объект viewerAttrsОбъект viewerAttrs

Объект mediaUrlОбъект mediaUrl

Объект mediaUrl.previewОбъект mediaUrl.preview

Объект FILE_MODELSОбъект FILE_MODELS

Объект FILE_MODELS.upload{id}Объект FILE_MODELS.upload{id}

Объект linksОбъект links

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

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

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

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