Upload File to Chat im.v2.File.upload

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: im

Who can execute the method: a user with access to the chat

The method im.v2.File.upload uploads a file to the chat on behalf of the current user. It combines three steps of the deprecated API into a single call: uploading the file to the Drive, attaching it to the chat, and sending a message.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
dialogId* `string`	ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}`
fields* `object`	Object with file and message parameters (detailed description)

Parameter fields

Name `Type`	Description
name* `string`	File name with extension
content* `string`	File content in Base64 encoding. Maximum size — 100 MB
message `string`	Text of the message sent along with the file

How to prepare the value for fields.content:

Read the file in binary format.
Encode the content in Base64.
Pass only the Base64 string, without the prefix data:*/*;base64,.

More details: How to upload files.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

Python

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);
        }

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.im.v2.file.upload(
                dialog_id="chat5",
                fields={
                    "name": "report.pdf",
                    "content": "SGVsbG8gV29ybGQh",
                    "message": "Here is the report",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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 and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        fmt.Println(item.DialogID, item.ChatID)

Response Handling

HTTP Status: 200

{
            "result": {
                "file": {
                    "id": 9817,
                    "chatId": 4415,
                    "date": "2026-08-11T15:28:50+02:00",
                    "type": "file",
                    "name": "report.pdf",
                    "extension": "pdf",
                    "size": 35341,
                    "image": false,
                    "status": "done",
                    "progress": 100,
                    "authorId": 1,
                    "authorName": "Klaus Weber",
                    "urlPreview": "",
                    "urlShow": "https://some-domain.bitrix24.com/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=9817&exact=N&fileName=report.pdf",
                    "urlDownload": "https://some-domain.bitrix24.com/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://some-domain.bitrix24.com/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://some-domain.bitrix24.com/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+02:00",
                "date_finish": "2026-08-11T15:28:50+02:00",
                "operating_reset_at": 1786451790,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `object`	Result of the operation
result.dialogId `string`	Identifier of the dialog
result.chatId `integer`	Numeric identifier of the chat
result.messageId `integer`	Identifier of the created message with the file
result.file `File`	Data of the uploaded file (detailed description)
time `time`	Information about the request execution time

File Object

Name `Type`	Description
id `integer`	Identifier of the file on Drive
chatId `integer`	Identifier of the chat
date `datetime`	Date the file was uploaded
type `string`	File type: `file`, `image`, `video`, `audio`
name `string`	Name of the file
extension `string`	File extension
size `integer`	Size of the file in bytes
image `boolean`	`false` for a regular file. For an image — an object with width and height
status `string`	Upload status, for example `done`
progress `integer`	Upload progress in percent
authorId `integer`	Identifier of the user who uploaded the file
authorName `string`	Name of the user who uploaded the file
urlPreview `string`	Link to the file preview or an empty string
urlShow `string`	Link to view the file
urlDownload `string`	Link to download the file
viewerAttrs `object`	Attributes for the built-in Bitrix24 viewer
mediaUrl `object`	Links to media file previews by size
isTranscribable `boolean`	Indicates a file that can be transcribed into text
isVideoNote `boolean`	Indicates a video message
isVoiceNote `boolean`	Indicates a voice message

A complete description of all object fields can be found on the Objects and Fields page.

Error Handling

HTTP Status: 400, 403

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

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description	Value
`FILE_EMPTY`	File name and content are required	The file name or content was not passed
`FILE_INVALID_CONTENT`	Invalid base64 content	The file content is not a Base64 string
`CHAT_NOT_FOUND`	CHAT_NOT_FOUND	The chat from `dialogId` was not found
`FOLDER_ERROR`	Failed to get chat folder	Failed to get chat folder
`UPLOAD_FAILED`	File upload failed	File upload error
`SEND_FAILED`	Failed to send message	Message sending error
`FILE_TOO_LARGE`	File is too large	File size exceeds 100 MB
`ACCESS_DENIED`	Access denied	No access to the chat

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	The REST API is available only on commercial plans. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Overview of Methods

Get a Download Link for the File

Upload File to Chat im.v2.File.upload

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

File ObjectFile Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning