Выполнить команду чат-бота im.message.command

Scope: im

Кто может выполнять метод: участник чата

Метод im.message.command выполняет команду чат-бота в контексте сообщения.

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

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

Название `тип`	Описание
MESSAGE_ID* `integer`	Идентификатор сообщения, в контексте которого выполняется команда. Идентификатор можно получить с помощью метода im.dialog.messages.get
BOT_ID* `integer`	Идентификатор бота. Идентификатор можно получить с помощью метода imbot.bot.list.
COMMAND* `string`	Команда бота. Текст указывается при регистрации команды чат-ботом через метод imbot.command.register
COMMAND_PARAMS `string`	Параметр команды

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"MESSAGE_ID":34261,"BOT_ID":1291,"COMMAND":"task","COMMAND_PARAMS":"task №1"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.command

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"MESSAGE_ID":34261,"BOT_ID":1291,"COMMAND":"task","COMMAND_PARAMS":"task №1","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.message.command

try
        {
            const response = await $b24.callMethod(
                'im.message.command',
                {
                    MESSAGE_ID: 34261,
                    BOT_ID: 1291,
                    COMMAND: 'task',
                    COMMAND_PARAMS: 'task №1'
                }
            );
            
            const result = response.getData().result;
            console.log('Executed command with result:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.message.command',
                    [
                        'MESSAGE_ID' => 34261,
                        'BOT_ID' => 1291,
                        'COMMAND' => 'task',
                        'COMMAND_PARAMS' => 'task №1'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error executing command: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.message.command',
            {
                MESSAGE_ID: 34261,
                BOT_ID: 1291,
                COMMAND: 'task',
                COMMAND_PARAMS: 'task №1'
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.message.command',
            [
                'MESSAGE_ID' => 34261,
                'BOT_ID' => 1291,
                'COMMAND' => 'task',
                'COMMAND_PARAMS' => 'task №1'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1772633574,
                "finish": 1772633574.201127,
                "duration": 0.2011270523071289,
                "processing": 0,
                "date_start": "2026-03-04T17:12:54+03:00",
                "date_finish": "2026-03-04T17:12:54+03:00",
                "operating_reset_at": 1772634174,
                "operating": 0.10915994644165039
            }
        }

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

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

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

HTTP-статус: 400

{
            "error": "PARAMS_ERROR",
            "error_description": "Incorrect params"
        }

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

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

Код	Описание	Значение
`MESSAGE_ID_ERROR`	Message ID can't be empty	Не передан или некорректен `MESSAGE_ID`
`BOT_ID_ERROR`	Bot ID can't be empty	Не передан или некорректен `BOT_ID`
`COMMAND_ERROR`	Command can't be empty	Не передан `COMMAND`
`PARAMS_ERROR`	Incorrect params	Некорректные параметры команды

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

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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Удалить сообщение

Обзор методов

Выполнить команду чат-бота im.message.command

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

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

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

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

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

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

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

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