Send a Response to the imbot.command.answer Command

Scope: imbot

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

The method imbot.command.answer publishes a response to a chatbot command.

Method Parameters

Required parameters are marked with *

Name
type

Description

COMMAND_ID*
integer

Command identifier. Required if COMMAND is not provided

COMMAND*
string

Text of the command. 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

Text of the response

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

Type of message:

  • Y - system message
  • N - regular message

Default - N

URL_PREVIEW
string

Link transformation into rich links:

  • Y - enabled
  • N - disabled

Default - 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 chatbot registration

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":"Received. 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":"Received. 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: 'Received. 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' => 'Received. 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: 'Received. 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' => 'Received. 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>';
        

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+02:00",
                "date_finish": "2026-02-26T13:39:19+02: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 may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning