Отправить ответ на команду imbot.command.answer

Scope: imbot

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

DEPRECATED

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

Метод imbot.command.answer публикует ответ на команду чат-бота.

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

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

Название
тип

Описание

COMMAND_ID*
integer

Идентификатор команды. Обязателен, если не передан COMMAND

COMMAND*
string

Текст команды. Обязателен, если не передан COMMAND_ID

MESSAGE_ID*
integer

Идентификатор сообщения, на которое отправляется ответ.

Идентификатор можно узнать из входящего события ONIMCOMMANDADD

MESSAGE*
string

Текст ответа

ATTACH
object

Объект с вложением к сообщению. Минимальный формат:

{
          "BLOCKS": [
            { "MESSAGE": "Текст блока" }
          ]
        }
        

Подробное описание

KEYBOARD
object

Клавиатура сообщения. Минимальный формат:

{
          "BUTTONS": [
            { "TEXT": "Повторить", "COMMAND": "echo repeat" }
          ]
        }
        

Подробное описание

MENU
object

Контекстное меню сообщения. Минимальный формат:

[
          { "TEXT": "bitrix24", "LINK": "https://bitrix24.ru" }
        ]
        

Подробное описание

SYSTEM
string

Тип сообщения:

  • Y - системное сообщение
  • N - обычное сообщение

По умолчанию - N

URL_PREVIEW
string

Преобразование ссылок в rich-ссылки:

  • Y - включено
  • N - выключено

По умолчанию - Y.

Работает для ссылок, переданных в поле MESSAGE

CLIENT_ID
string

Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

Примеры кода

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

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"COMMAND_ID":99,"MESSAGE_ID":33871,"MESSAGE":"Принято. Выполняю команду.","SYSTEM":"N","URL_PREVIEW":"Y","ATTACH":{"BLOCKS":[{"MESSAGE":"Детали задачи"},{"DELIMITER":true},{"LINK":{"NAME":"Открыть","LINK":"https://example.com"}}]},"KEYBOARD":{"BUTTONS":[{"TEXT":"Повторить","COMMAND":"echo repeat"}]},"MENU":[{"TEXT":"bitrix24","LINK":"https://bitrix24.ru"}],"CLIENT_ID":"**put_your_client_id_here**"}' /
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.command.answer
        
curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"COMMAND_ID":99,"MESSAGE_ID":33871,"MESSAGE":"Принято. Выполняю команду.","SYSTEM":"N","URL_PREVIEW":"Y","ATTACH":{"BLOCKS":[{"MESSAGE":"Детали задачи"},{"DELIMITER":true},{"LINK":{"NAME":"Открыть","LINK":"https://example.com"}}]},"KEYBOARD":{"BUTTONS":[{"TEXT":"Повторить","COMMAND":"echo repeat"}]},"MENU":[{"TEXT":"bitrix24","LINK":"https://bitrix24.ru"}],"auth":"**put_access_token_here**"}' /
        https://**put_your_bitrix24_address**/rest/imbot.command.answer
        
try
        {
            const response = await $b24.callMethod(
                'imbot.command.answer',
                {
                    COMMAND_ID: 99,
                    MESSAGE_ID: 33871,
                    MESSAGE: 'Принято. Выполняю команду.',
                    SYSTEM: 'N',
                    URL_PREVIEW: 'Y',
                    ATTACH: {
                        BLOCKS: [
                            {MESSAGE: 'Детали задачи'},
                            {DELIMITER: true},
                            {LINK: {NAME: 'Открыть', LINK: 'https://example.com'}}
                        ]
                    },
                    KEYBOARD: {
                        BUTTONS: [
                            {TEXT: 'Повторить', COMMAND: 'echo repeat'}
                        ]
                    },
                    MENU: [
                        {TEXT: 'bitrix24', LINK: 'https://bitrix24.ru'}
                    ]
                }
            );
            
            const result = response.getData().result;
            console.log('Answered command with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.command.answer',
                    [
                        'COMMAND_ID' => 99,
                        'MESSAGE_ID' => 33871,
                        'MESSAGE' => 'Принято. Выполняю команду.',
                        'SYSTEM' => 'N',
                        'URL_PREVIEW' => 'Y',
                        'ATTACH' => [
                            'BLOCKS' => [
                                ['MESSAGE' => 'Детали задачи'],
                                ['DELIMITER' => true],
                                ['LINK' => ['NAME' => 'Открыть', 'LINK' => 'https://example.com']]
                            ]
                        ],
                        'KEYBOARD' => [
                            'BUTTONS' => [
                                ['TEXT' => 'Повторить', 'COMMAND' => 'echo repeat']
                            ]
                        ],
                        'MENU' => [
                            ['TEXT' => 'bitrix24', 'LINK' => 'https://bitrix24.ru']
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error answering command: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'imbot.command.answer',
            {
                COMMAND_ID: 99,
                MESSAGE_ID: 33871,
                MESSAGE: 'Принято. Выполняю команду.',
                SYSTEM: 'N',
                URL_PREVIEW: 'Y',
                ATTACH: {
                    BLOCKS: [
                        {MESSAGE: 'Детали задачи'},
                        {DELIMITER: true},
                        {LINK: {NAME: 'Открыть', LINK: 'https://example.com'}}
                    ]
                },
                KEYBOARD: {
                    BUTTONS: [
                        {TEXT: 'Повторить', COMMAND: 'echo repeat'}
                    ]
                },
                MENU: [
                        {TEXT: 'bitrix24', LINK: 'https://bitrix24.ru'}
                ]
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.command.answer',
            [
                'COMMAND_ID' => 99,
                'MESSAGE_ID' => 33871,
                'MESSAGE' => 'Принято. Выполняю команду.',
                'SYSTEM' => 'N',
                'URL_PREVIEW' => 'Y',
                'ATTACH' => [
                    'BLOCKS' => [
                        ['MESSAGE' => 'Детали задачи'],
                        ['DELIMITER' => true],
                        ['LINK' => ['NAME' => 'Открыть', 'LINK' => 'https://example.com']]
                    ]
                ],
                'KEYBOARD' => [
                    'BUTTONS' => [
                        ['TEXT' => 'Повторить', 'COMMAND' => 'echo repeat']
                    ]
                ],
                'MENU' => [
                    ['TEXT' => 'bitrix24', 'LINK' => 'https://bitrix24.ru']
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": 33879,
            "time": {
                "start": 1772102358,
                "finish": 1772102359.061859,
                "duration": 1.061858892440796,
                "processing": 1,
                "date_start": "2026-02-26T13:39:18+03:00",
                "date_finish": "2026-02-26T13:39:19+03:00",
                "operating_reset_at": 1772102958,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
integer

Идентификатор отправленного сообщения-ответа

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "MESSAGE_EMPTY",
            "error_description": "Message can't be empty"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

COMMAND_ID_ERROR

Command not found

Команда не найдена

APP_ID_ERROR

Command was installed by another rest application

Команда зарегистрирована другим приложением

MESSAGE_ID_EMPTY

Message ID can't be empty

Не передан MESSAGE_ID

MESSAGE_EMPTY

Message can't be empty

Не передан текст сообщения

ATTACH_ERROR

Incorrect attach params

Невалидный объект ATTACH

ATTACH_OVERSIZE

You have exceeded the maximum allowable size of attach

Размер ATTACH превышает допустимый

KEYBOARD_ERROR

Incorrect keyboard params

Невалидный объект KEYBOARD

KEYBOARD_OVERSIZE

You have exceeded the maximum allowable size of keyboard

Размер KEYBOARD превышает допустимый

MENU_ERROR

Incorrect menu params

Невалидный объект MENU

WRONG_REQUEST

Message isn't added

Не удалось отправить сообщение

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

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

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

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