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's 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 Change Log for imbot.v2.

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 when registering the chatbot
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 a two-letter lowercase language code: `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 command invocation: ONIMBOTV2COMMANDADD.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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);
        }

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'];
        }

Response Handling

HTTP Code: 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

A 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 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
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	`botToken` is not provided. Required for webhook authorization
`BOT_ID_REQUIRED`	Bot ID is required	`botId` is not provided
`BOT_NOT_FOUND`	Bot not found	Bot not found
`BOT_OWNERSHIP_ERROR`	Bot is registered by another application	Bot is 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 occurred during command registration

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Update the imbot.v2.Command.update
Get the List of Commands imbot.v2.Command.list
Remove the imbot.v2.Command.unregister Command
Responding to the imbot.v2.Command.answer Command
API Change Log for imbot.v2 — the method call format has changed, the old format will be supported until 2026-09

Overview of Methods

Update a Team

Register the Team imbot.v2.Command.register

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Common and Local CommandsCommon and Local Commands

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the Command ObjectFields of the Command Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning