Добавить команду imbot.command.register

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

Кто может выполнять метод: пользователь приложения, которое зарегистрировало чат-бота

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Command.register.

Метод imbot.command.register регистрирует команду для чат-бота.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
BOT_ID* `integer`	Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list
COMMAND* `string`	Текст команды, которую пользователь вводит в чате. Можно использовать латинские буквы и цифры без пробелов и специальных символов
EVENT_COMMAND_ADD* `string`	URL обработчика события ONIMCOMMANDADD, который вызывается при использовании команды
LANG* `array`	Массив локализаций команды. Структура описана ниже
COMMON `string`	Доступность команды: `Y` - команда доступна в любых чатах `N` - команда доступна только там, где есть бот По умолчанию - `N`
HIDDEN `string`	Видимость команды: `Y` - скрытая команда `N` - видимая команда По умолчанию - `N`
EXTRANET_SUPPORT `string`	Доступность команды пользователям экстранета: `Y` - доступна `N` - недоступна По умолчанию - `N`
CLIENT_ID `string`	Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

Параметр LANG

Название `тип`	Описание
LANGUAGE_ID* `string`	Идентификатор языка, например `ru` или `en`
TITLE* `string`	Название команды на выбранном языке
PARAMS `string`	Подсказка по параметрам команды на выбранном языке

При регистрации нескольких команд указывайте один и тот же URL в EVENT_COMMAND_ADD, а разбор конкретной команды выполняйте в коде обработчика по COMMAND/COMMAND_ID

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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":"ru","TITLE":"Эхо","PARAMS":"текст"},{"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":"ru","TITLE":"Эхо","PARAMS":"текст"},{"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: 'ru', TITLE: 'Эхо', PARAMS: 'текст' },
                { 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' => 'ru', 'TITLE' => 'Эхо', 'PARAMS' => 'текст'],
                    ['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: 'ru', TITLE: 'Эхо', PARAMS: 'текст' },
            { 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' => 'ru', 'TITLE' => 'Эхо', 'PARAMS' => 'текст'],
            ['LANGUAGE_ID' => 'en', 'TITLE' => 'Echo', 'PARAMS' => 'text']
        ],
        'COMMON' => 'Y',
        'HIDDEN' => 'N',
        'EXTRANET_SUPPORT' => 'N'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
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":       "Эхо",
			"PARAMS":      "текст",
		},
		{
			"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("разбор ответа: %w", err)
}
fmt.Println("результат:", value)

Обработка ответа

HTTP-статус: 200

{
    "result": 99,
    "time": {
        "start": 1772088116,
        "finish": 1772088116.785232,
        "duration": 0.7852320671081543,
        "processing": 0,
        "date_start": "2026-02-26T09:41:56+03:00",
        "date_finish": "2026-02-26T09:41:56+03:00",
        "operating_reset_at": 1772088716,
        "operating": 0.49926185607910156
    }
}

Возвращаемые данные

Название `тип`	Описание
result `integer`	Идентификатор зарегистрированной команды
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код	Описание	Значение
`EVENT_COMMAND_ADD_ERROR`	Handler for "Command add" event isn't specified	Не передан параметр `EVENT_COMMAND_ADD`
`EVENT_COMMAND_ADD_ERROR`	Wrong handler URL	Передан невалидный URL обработчика события добавления команды
`COMMAND_ERROR`	Command isn't specified	Не указан текст команды
`BOT_ID_ERROR`	Bot not found	Чат-бот не найден
`APP_ID_ERROR`	Bot was installed by another rest application	Чат-бот зарегистрирован другим приложением
`LANG_ERROR`	Lang set can't be empty	Не передан массив локализаций `LANG`
`WRONG_REQUEST`	Command can't be created	Не удалось зарегистрировать команду

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

О командах чат-ботов

Изменить команду

Добавить команду imbot.command.register

Параметры методаПараметры метода

Параметр LANGПараметр LANG

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение