Add the imbot.command.register Command

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

The development of this method has been halted. Please use imbot.v2.Command.register.

The imbot.command.register method registers a command for the chat bot.

Method Parameters

Required parameters are marked with *

Name
type

Description

BOT_ID*
integer

The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method

COMMAND*
string

The text of the command that the user types in the chat. Latin letters and numbers can be used without spaces and special characters

EVENT_COMMAND_ADD*
string

The URL of the event handler ONIMCOMMANDADD that is triggered when the command is used

LANG*
array

An array of localizations for the command. The structure is described below

COMMON
string

Command availability:

  • Y - the command is available in any chats
  • N - the command is only available where the bot is present

Default is N

HIDDEN
string

Command visibility:

  • Y - hidden command
  • N - visible command

Default is N

EXTRANET_SUPPORT
string

Command availability for extranet users:

  • Y - available
  • N - not available

Default is N

CLIENT_ID
string

This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot

LANG Parameter

Name
type

Description

LANGUAGE_ID*
string

Language identifier, for example de or en

TITLE*
string

The name of the command in the selected language

PARAMS
string

Parameter hints for the command in the selected language

When registering multiple commands, specify the same URL in EVENT_COMMAND_ADD, and parse the specific command in the handler code by COMMAND/COMMAND_ID.

Code Examples

How to Use Examples in Documentation

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"BOT_ID":1291,"COMMAND":"echo","EVENT_COMMAND_ADD":"https://example.com/bot/command.php","LANG":[{"LANGUAGE_ID":"de","TITLE":"Echo","PARAMS":"text"},{"LANGUAGE_ID":"en","TITLE":"Echo","PARAMS":"text"}],"COMMON":"Y","HIDDEN":"N","EXTRANET_SUPPORT":"N","CLIENT_ID":"**put_your_client_id_here**"}' /
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.command.register
        
curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"BOT_ID":1291,"COMMAND":"echo","EVENT_COMMAND_ADD":"https://example.com/bot/command.php","LANG":[{"LANGUAGE_ID":"de","TITLE":"Echo","PARAMS":"text"},{"LANGUAGE_ID":"en","TITLE":"Echo","PARAMS":"text"}],"COMMON":"Y","HIDDEN":"N","EXTRANET_SUPPORT":"N","auth":"**put_access_token_here**"}' /
        https://**put_your_bitrix24_address**/rest/imbot.command.register
        
try
        {
            const response = await $b24.callMethod(
                'imbot.command.register',
                {
                    BOT_ID: 1291,
                    COMMAND: 'echo',
                    EVENT_COMMAND_ADD: 'https://example.com/bot/command.php',
                    LANG: [
                        { LANGUAGE_ID: 'de', TITLE: 'Echo', PARAMS: 'text' },
                        { LANGUAGE_ID: 'en', TITLE: 'Echo', PARAMS: 'text' }
                    ],
                    COMMON: 'Y',
                    HIDDEN: 'N',
                    EXTRANET_SUPPORT: 'N'
                }
            );
            
            const result = response.getData().result;
            console.log('Created element with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.command.register',
                    [
                        'BOT_ID' => 1291,
                        'COMMAND' => 'echo',
                        'EVENT_COMMAND_ADD' => 'https://example.com/bot/command.php',
                        'LANG' => [
                            ['LANGUAGE_ID' => 'de', 'TITLE' => 'Echo', 'PARAMS' => 'text'],
                            ['LANGUAGE_ID' => 'en', 'TITLE' => 'Echo', 'PARAMS' => 'text']
                        ],
                        'COMMON' => 'Y',
                        'HIDDEN' => 'N',
                        'EXTRANET_SUPPORT' => 'N'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding product row: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'imbot.command.register',
            {
                BOT_ID: 1291,
                COMMAND: 'echo',
                EVENT_COMMAND_ADD: 'https://example.com/bot/command.php',
                LANG: [
                    { LANGUAGE_ID: 'de', TITLE: 'Echo', PARAMS: 'text' },
                    { LANGUAGE_ID: 'en', TITLE: 'Echo', PARAMS: 'text' }
                ],
                COMMON: 'Y',
                HIDDEN: 'N',
                EXTRANET_SUPPORT: 'N'
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.command.register',
            [
                'BOT_ID' => 1291,
                'COMMAND' => 'echo',
                'EVENT_COMMAND_ADD' => 'https://example.com/bot/command.php',
                'LANG' => [
                    ['LANGUAGE_ID' => 'de', 'TITLE' => 'Echo', 'PARAMS' => 'text'],
                    ['LANGUAGE_ID' => 'en', 'TITLE' => 'Echo', 'PARAMS' => 'text']
                ],
                'COMMON' => 'Y',
                'HIDDEN' => 'N',
                'EXTRANET_SUPPORT' => 'N'
            ]
        );
        
        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.register", b24.Params{
        	"BOT_ID":            1291,
        	"COMMAND":           "echo",
        	"EVENT_COMMAND_ADD": "https://example.com/bot/command.php",
        	"LANG": []b24.Params{
        		{
        			"LANGUAGE_ID": "ru",
        			"TITLE":       "Echo",
        			"PARAMS":      "text",
        		},
        		{
        			"LANGUAGE_ID": "en",
        			"TITLE":       "Echo",
        			"PARAMS":      "text",
        		},
        	},
        	"COMMON":           "Y",
        	"HIDDEN":           "N",
        	"EXTRANET_SUPPORT": "N",
        	"CLIENT_ID":        "**put_your_client_id_here**",
        })
        if err != nil {
        	return fmt.Errorf("imbot.command.register: %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": 99,
            "time": {
                "start": 1772088116,
                "finish": 1772088116.785232,
                "duration": 0.7852320671081543,
                "processing": 0,
                "date_start": "2026-02-26T09:41:56+01:00",
                "date_finish": "2026-02-26T09:41:56+01:00",
                "operating_reset_at": 1772088716,
                "operating": 0.49926185607910156
            }
        }
        

Returned Data

Name
type

Description

result
integer

The identifier of the registered command

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "COMMAND_ERROR",
            "error_description": "Command isn't specified"
        }
        

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

EVENT_COMMAND_ADD_ERROR

Handler for "Command add" event isn't specified

The EVENT_COMMAND_ADD parameter is not provided

EVENT_COMMAND_ADD_ERROR

Wrong handler URL

An invalid event handler URL for adding the command is provided

COMMAND_ERROR

Command isn't specified

The command text is not specified

BOT_ID_ERROR

Bot not found

The chat bot is not found

APP_ID_ERROR

Bot was installed by another REST application

The chat bot was registered by another application

LANG_ERROR

Lang set can't be empty

The LANG localization array is not provided

WRONG_REQUEST

Command can't be created

The command could not be registered

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