Send Message im.message.add

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: im

Who can execute the method: a user with permission to send messages in chat

The method im.message.add sends a message to a chat.

Method Parameters

Required parameters are marked with *

Name
type

Description

DIALOG_ID*
string

Identifier of the chat in the format:

  • chatXXX — chat
  • sgXXX — group or project chat
  • XXX — identifier of the personal chat user

The chat identifier can be obtained using the im.chat.get method. The user identifier can be obtained using the user.get and user.search methods

MESSAGE*
string

The text of the message. Required if ATTACH is not provided.

Formatting is supported

ATTACH
object
string

Attachment with content blocks: images, links, files. Required if MESSAGE is not provided.

Read more in the Attachments section

KEYBOARD
object
string

Buttons under the message that the user can interact with.

Read more in the Working with Keyboards article

MENU
object
string

Additional items in the chat's context menu.

Read more in the Context Menu article

SYSTEM
string

Indicator of a system message.

Allowed values:

  • Y — system message
  • N — regular message

Default is N

URL_PREVIEW
string

Conversion of links into rich links.

Allowed values:

  • Y — enabled
  • N — disabled

Default is Y

REPLY_ID
integer

Identifier of the message to which the reply is sent. The message for the reply must be in the same chat.

The identifier can be obtained using the im.dialog.messages.get method

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DIALOG_ID":"chat2941","MESSAGE":"Message text","SYSTEM":"N","URL_PREVIEW":"Y","REPLY_ID":34237}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DIALOG_ID":"chat2941","MESSAGE":"Message text","SYSTEM":"N","URL_PREVIEW":"Y","REPLY_ID":34237,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.message.add
        
// 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
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'im.message.add',
            params: {
              DIALOG_ID: 'chat2941',
              MESSAGE: 'Message text',
              SYSTEM: 'N',
              URL_PREVIEW: 'Y',
              REPLY_ID: 34237,
            },
            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('Created message with ID:', result)
          }
        } 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 sendMessage() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'im.message.add',
                params: {
                  DIALOG_ID: 'chat2941',
                  MESSAGE: 'Message text',
                  SYSTEM: 'N',
                  URL_PREVIEW: 'Y',
                  REPLY_ID: 34237,
                },
                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('Created message with ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendMessage)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.im.message.add(
                dialog_id="chat2941",
                message="Message text",
                system=False,
                url_preview=True,
                reply_id=34237,
            ).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.message.add',
                    [
                        'DIALOG_ID' => 'chat2941',
                        'MESSAGE' => 'Message text',
                        'SYSTEM' => 'N',
                        'URL_PREVIEW' => 'Y',
                        'REPLY_ID' => 34237
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding message: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.message.add',
            {
                DIALOG_ID: 'chat2941',
                MESSAGE: 'Message text',
                SYSTEM: 'N',
                URL_PREVIEW: 'Y',
                REPLY_ID: 34237
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.message.add',
            [
                'DIALOG_ID' => 'chat2941',
                'MESSAGE' => 'Message text',
                'SYSTEM' => 'N',
                'URL_PREVIEW' => 'Y',
                'REPLY_ID' => 34237
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "im.message.add", b24.Params{
        	"DIALOG_ID":   "chat2941",
        	"MESSAGE":     "Message text",
        	"SYSTEM":      "N",
        	"URL_PREVIEW": "Y",
        	"REPLY_ID":    34237,
        })
        if err != nil {
        	return fmt.Errorf("im.message.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)
        

Response Handling

HTTP Status: 200

{
            "result": 34239,
            "time": {
                "start": 1772552939,
                "finish": 1772552939.091396,
                "duration": 0.09139609336853027,
                "processing": 0,
                "date_start": "2026-03-03T17:48:59+01:00",
                "date_finish": "2026-03-03T17:48:59+01:00",
                "operating_reset_at": 1772553539,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the sent message

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "MESSAGE_EMPTY",
            "error_description": "Message can't be empty"
        }
        

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

MESSAGE_EMPTY

Message can't be empty

Empty MESSAGE and ATTACH not provided

USER_ID_EMPTY

User ID can't be empty

User identifier in DIALOG_ID is not provided or is invalid

USER_NOT_FOUND

User not found

User not found

CHAT_ID

Error creating message

Failed to create message. Ensure that a chat with such ID exists

ACCESS_ERROR

Action unavailable

Insufficient permissions to send the message

PARAMS_ERROR

Incorrect params

Invalid set of request parameters

ATTACH_ERROR

Incorrect attach params

Invalid ATTACH object

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

The size of ATTACH exceeds the allowable limit

KEYBOARD_ERROR

Incorrect keyboard params

Invalid KEYBOARD object

MENU_ERROR

Incorrect menu params

Invalid MENU object

REPLY_ACCESS_ERROR

Action unavailable

No access to the message in REPLY_ID

REPLY_FROM_OTHER_CHAT_ERROR

You can only reply to a message within the same chat

Cannot reply to a message from another 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

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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