Register the Team imbot.v2.Command.register

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: owner of the registered bot

The method imbot.v2.Command.register registers a bot slash command.

The method is idempotent: a repeated call with the same command for the same bot from the same application returns the existing command without updating the data. To update, use imbot.v2.Command.update.

The method call format has changed: command parameters are now passed in the fields object. The old flat format will be supported until 30.09.2026. For more details, see API imbot.v2 Change Log.

Method Parameters

Required parameters are marked with *

Name
Type

Description

botId*
integer

Bot ID

botToken
string

Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth.

Pass the same botToken that was specified during the chat bot registration

fields*
object

Object with command parameters (detailed description)

Parameter fields

Name
Type

Description

command*
string

Command without the / symbol. For example: help

title
object

Title of the command in different languages. An object {langCode: text}, where langCode is the two-letter language code in lowercase: en, de, etc.

Displayed in the list of available commands. Required for visible commands hidden: false. For hidden commands hidden: true, it can be omitted

params
object

Description of command parameters in different languages. An object {langCode: text}, similar to title. Displayed as a hint next to the command

common
boolean

Common command. Acceptable values: true, false. Default is false. For more details, see Common and Local Commands

hidden
boolean

Hidden command. Acceptable values: true, false. Default is false

extranetSupport
boolean

Extranet support. Acceptable values: true, false. Default is false

Boolean parameters accept true and false. If the client does not support JSON boolean, strings "Y" and "N" can be passed.

Common and Local Commands

The common parameter defines where the command is available:

  • common: true — common command, available in any chat
  • common: false — local command, available only in a personal dialogue with the bot and in chats where the bot is a participant

Typical use-cases:

  • Common commands are suitable for global actions, such as searching or help without the bot needing to be present in the chat.
  • Local commands are suitable for actions tied to a specific bot and the context of its chat.

The event for invoking the command: ONIMBOTV2COMMANDADD.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"my_bot_token","fields":{"command":"help","title":{"en":"Show help","de":"Hilfe anzeigen"},"params":{"en":"query","de":"Anfrage"}}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.register
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"fields":{"command":"help","title":{"en":"Show help","de":"Hilfe anzeigen"},"params":{"en":"query","de":"Anfrage"}},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Command.register
        
try {
          const response = await $b24.callMethod('imbot.v2.Command.register', {
            botId: 456,
            fields: {
              command: 'help',
              title: { en: 'Show help', de: 'Hilfe anzeigen' },
              params: { en: 'query', de: 'Anfrage' },
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imbot.v2.command.register(
                bot_id=456,
                fields={
                    "command": "help",
                    "title": {
                        "en": "Show help",
                        "ru": "Show help",
                    },
                    "params": {
                        "en": "query",
                        "ru": "exactly",
                    },
                },
            ).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(
                    'imbot.v2.Command.register',
                    [
                        'botId' => 456,
                        'fields' => [
                            'command' => 'help',
                            'title' => ['en' => 'Show help', 'de' => 'Hilfe anzeigen'],
                            'params' => ['en' => 'query', 'de' => 'Anfrage'],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'result: '. print_r($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error: '. $exception->getMessage();
        }
        
BX24.callMethod(
            'imbot.v2.Command.register',
            {
                botId: 456,
                fields: {
                    command: 'help',
                    title: { en: 'Show help', de: 'Hilfe anzeigen' },
                    params: { en: 'query', de: 'Anfrage' },
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Command.register',
            [
                'botId' => 456,
                'fields' => [
                    'command' => 'help',
                    'title' => ['en' => 'Show help', 'de' => 'Hilfe anzeigen'],
                    'params' => ['en' => 'query', 'de' => 'Anfrage'],
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'Command ID: '. $result['result']['command']['id'];
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.v2.Command.register", b24.Params{
        	"botId":    456,
        	"botToken": "my_bot_token",
        	"fields": b24.Params{
        		"command": "help",
        		"title": b24.Params{
        			"en": "Show help",
        		},
        		"params": b24.Params{
        			"en": "query",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("imbot.v2.Command.register: %w", err)
        }
        
        // The method wraps the response in an object with the "command" key.
        raw, ok := b24.Unwrap(res.Result, "command")
        if !ok {
        	return fmt.Errorf("no command key in the response")
        }
        
        var item struct {
        	ID              b24.ID `json:"id"`
        	BotID           b24.ID `json:"botId"`
        	Command         string `json:"command"`
        	Common          bool   `json:"common"`
        	Hidden          bool   `json:"hidden"`
        	ExtranetSupport bool   `json:"extranetSupport"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.BotID)
        

Response Handling

HTTP status: 200

{
            "result": {
                "command": {
                    "id": 42,
                    "botId": 456,
                    "command": "/help",
                    "common": false,
                    "hidden": false,
                    "extranetSupport": false
                }
            },
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00"
            }
        }
        

Returned Data

Name
Type

Description

result
object

Result of the operation

result.command
Command

Object of the registered command (detailed description)

time
time

Information about the request execution time

Fields of the Command Object

Field
Type

Description

id
integer

Identifier of the command

botId
integer

Identifier of the bot

command
string

Text of the command

common
boolean

Command available in all chats

hidden
boolean

Command hidden from the command list

extranetSupport
boolean

Command available to extranet users

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

Error Handling

HTTP status: 400, 403

{
            "error": "COMMAND_REQUIRED",
            "error_description": "Command is required"
        }
        

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

BOT_TOKEN_NOT_SPECIFIED

Bot token is not specified

botToken is not specified. Required for webhook authorization

BOT_ID_REQUIRED

Bot ID is required

botId is not specified

BOT_NOT_FOUND

Bot not found

Bot not found

BOT_OWNERSHIP_ERROR

Bot is registered by another application

Bot registered by another application

COMMAND_NAME_INVALID

Command name is invalid

Command name must be a string

COMMAND_REQUIRED

Command is required

Command (fields.command) is not specified

COMMAND_TITLE_REQUIRED

Command title is required

fields.title is not specified for visible command fields.hidden: false

COMMAND_REGISTER_FAILED

Command registration failed

Error registering command

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