Send a response to the command imbot.command.answer

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: imbot

Who can execute the method: a user of the application that registered the chat bot

DEPRECATED

Development of this method has been halted. Please use imbot.v2.Command.answer.

The method imbot.command.answer publishes a response to a chat bot command.

Method Parameters

Required parameters are marked with *

Name
type

Description

COMMAND_ID*
integer

Command identifier. Required if COMMAND is not provided

COMMAND*
string

Command text. Required if COMMAND_ID is not provided

MESSAGE_ID*
integer

Identifier of the message to which the response is sent.

The identifier can be obtained from the incoming event ONIMCOMMANDADD

MESSAGE
string

Response text

ATTACH
object

Object with an attachment to the message. Minimum format:

{
          "BLOCKS": [
            { "MESSAGE": "Block text" }
          ]
        }
        

Detailed description

KEYBOARD
object

Message keyboard. Minimum format:

{
          "BUTTONS": [
            { "TEXT": "Repeat", "COMMAND": "echo repeat" }
          ]
        }
        

Detailed description

MENU
object

Context menu of the message. Minimum format:

[
          { "TEXT": "bitrix24", "LINK": "https://bitrix24.com" }
        ]
        

Detailed description

SYSTEM
string

Message type:

  • Y - system message
  • N - regular message

Default is N

URL_PREVIEW
string

Link transformation into rich links:

  • Y - enabled
  • N - disabled

Default is Y.

Works for links provided in the MESSAGE field

CLIENT_ID
string

This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot

Code Examples

How to Use Examples in Documentation

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"COMMAND_ID":99,"MESSAGE_ID":33871,"MESSAGE":"Accepted. Executing command.","SYSTEM":"N","URL_PREVIEW":"Y","ATTACH":{"BLOCKS":[{"MESSAGE":"Task details"},{"DELIMITER":true},{"LINK":{"NAME":"Open","LINK":"https://example.com"}}]},"KEYBOARD":{"BUTTONS":[{"TEXT":"Repeat","COMMAND":"echo repeat"}]},"MENU":[{"TEXT":"bitrix24","LINK":"https://bitrix24.com"}],"CLIENT_ID":"**put_your_client_id_here**"}' /
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.command.answer
        
curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"COMMAND_ID":99,"MESSAGE_ID":33871,"MESSAGE":"Accepted. Executing command.","SYSTEM":"N","URL_PREVIEW":"Y","ATTACH":{"BLOCKS":[{"MESSAGE":"Task details"},{"DELIMITER":true},{"LINK":{"NAME":"Open","LINK":"https://example.com"}}]},"KEYBOARD":{"BUTTONS":[{"TEXT":"Repeat","COMMAND":"echo repeat"}]},"MENU":[{"TEXT":"bitrix24","LINK":"https://bitrix24.com"}],"auth":"**put_access_token_here**"}' /
        https://**put_your_bitrix24_address**/rest/imbot.command.answer
        
try
        {
            const response = await $b24.callMethod(
                'imbot.command.answer',
                {
                    COMMAND_ID: 99,
                    MESSAGE_ID: 33871,
                    MESSAGE: 'Accepted. Executing command.',
                    SYSTEM: 'N',
                    URL_PREVIEW: 'Y',
                    ATTACH: {
                        BLOCKS: [
                            {MESSAGE: 'Task details'},
                            {DELIMITER: true},
                            {LINK: {NAME: 'Open', LINK: 'https://example.com'}}
                        ]
                    },
                    KEYBOARD: {
                        BUTTONS: [
                            {TEXT: 'Repeat', COMMAND: 'echo repeat'}
                        ]
                    },
                    MENU: [
                        {TEXT: 'bitrix24', LINK: 'https://bitrix24.com'}
                    ]
                }
            );
            
            const result = response.getData().result;
            console.log('Answered command with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.command.answer',
                    [
                        'COMMAND_ID' => 99,
                        'MESSAGE_ID' => 33871,
                        'MESSAGE' => 'Accepted. Executing command.',
                        'SYSTEM' => 'N',
                        'URL_PREVIEW' => 'Y',
                        'ATTACH' => [
                            'BLOCKS' => [
                                ['MESSAGE' => 'Task details'],
                                ['DELIMITER' => true],
                                ['LINK' => ['NAME' => 'Open', 'LINK' => 'https://example.com']]
                            ]
                        ],
                        'KEYBOARD' => [
                            'BUTTONS' => [
                                ['TEXT' => 'Repeat', 'COMMAND' => 'echo repeat']
                            ]
                        ],
                        'MENU' => [
                            ['TEXT' => 'bitrix24', 'LINK' => 'https://bitrix24.com']
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error answering command: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'imbot.command.answer',
            {
                COMMAND_ID: 99,
                MESSAGE_ID: 33871,
                MESSAGE: 'Accepted. Executing command.',
                SYSTEM: 'N',
                URL_PREVIEW: 'Y',
                ATTACH: {
                    BLOCKS: [
                        {MESSAGE: 'Task details'},
                        {DELIMITER: true},
                        {LINK: {NAME: 'Open', LINK: 'https://example.com'}}
                    ]
                },
                KEYBOARD: {
                    BUTTONS: [
                        {TEXT: 'Repeat', COMMAND: 'echo repeat'}
                    ]
                },
                MENU: [
                        {TEXT: 'bitrix24', LINK: 'https://bitrix24.com'}
                ]
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.command.answer',
            [
                'COMMAND_ID' => 99,
                'MESSAGE_ID' => 33871,
                'MESSAGE' => 'Accepted. Executing command.',
                'SYSTEM' => 'N',
                'URL_PREVIEW' => 'Y',
                'ATTACH' => [
                    'BLOCKS' => [
                        ['MESSAGE' => 'Task details'],
                        ['DELIMITER' => true],
                        ['LINK' => ['NAME' => 'Open', 'LINK' => 'https://example.com']]
                    ]
                ],
                'KEYBOARD' => [
                    'BUTTONS' => [
                        ['TEXT' => 'Repeat', 'COMMAND' => 'echo repeat']
                    ]
                ],
                'MENU' => [
                    ['TEXT' => 'bitrix24', 'LINK' => 'https://bitrix24.com']
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.command.answer", b24.Params{
        	"COMMAND_ID":  99,
        	"MESSAGE_ID":  33871,
        	"MESSAGE":     "Accepted. Executing command.",
        	"SYSTEM":      "N",
        	"URL_PREVIEW": "Y",
        	"ATTACH": b24.Params{
        		"BLOCKS": []b24.Params{
        			{
        				"MESSAGE": "Task details",
        			},
        			{
        				"DELIMITER": true,
        			},
        			{
        				"LINK": b24.Params{
        					"NAME": "Open",
        					"LINK": "https://example.com",
        				},
        			},
        		},
        	},
        	"KEYBOARD": b24.Params{
        		"BUTTONS": []b24.Params{
        			{
        				"TEXT":    "Repeat",
        				"COMMAND": "echo repeat",
        			},
        		},
        	},
        	"MENU": []b24.Params{
        		{
        			"TEXT": "bitrix24",
        			"LINK": "https://bitrix24.com",
        		},
        	},
        	"CLIENT_ID": "**put_your_client_id_here**",
        })
        if err != nil {
        	return fmt.Errorf("imbot.command.answer: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)
        

Response Handling

HTTP Status: 200

{
            "result": 33879,
            "time": {
                "start": 1772102358,
                "finish": 1772102359.061859,
                "duration": 1.061858892440796,
                "processing": 1,
                "date_start": "2026-02-26T13:39:18+01:00",
                "date_finish": "2026-02-26T13:39:19+01:00",
                "operating_reset_at": 1772102958,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the sent response 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

COMMAND_ID_ERROR

Command not found

Command not found

APP_ID_ERROR

Command was installed by another rest application

Command registered by another application

MESSAGE_ID_EMPTY

Message ID can't be empty

MESSAGE_ID not provided

MESSAGE_EMPTY

Message can't be empty

Message text not provided

ATTACH_ERROR

Incorrect attach params

Invalid ATTACH object

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

ATTACH size exceeds the allowable limit

KEYBOARD_ERROR

Incorrect keyboard params

Invalid KEYBOARD object

KEYBOARD_OVERSIZE

You have exceeded the maximum allowable size of keyboard

KEYBOARD size exceeds the allowable limit

MENU_ERROR

Incorrect menu params

Invalid MENU object

WRONG_REQUEST

Message isn't added

Failed to send message

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