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

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

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

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`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`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-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

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

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

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

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

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

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

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

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

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

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

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