Ответить на команду imbot.v2.Command.answer

Scope: imbot

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

Метод imbot.v2.Command.answer отправляет ответ бота на вызов слэш-команды.

Бот может ответить в чат, из которого пришла команда, даже если бот не является участником этого чата. Доступ предоставляется временно на основе токена команды — messageId + commandId. Если бот не является участником чата, сообщение отправляется как системное с указанием имени бота.

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

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

Название `Тип`	Описание
botId* `integer`	ID бота
botToken `string`	Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота
commandId* `integer`	ID команды
messageId* `integer`	ID сообщения с командой
dialogId* `string`	ID диалога. Для групповых чатов — `chat{chatId}`, для личных — `{userId}`
fields `object`	Поля ответного сообщения. Структура объекта описана ниже

Параметр fields

Название `Тип`	Описание
message `string`	Текст ответа. Максимальная длина — 20 000 символов
attach `array`	Вложения. Подробнее: Как использовать вложения
keyboard `array`	Клавиатура. Подробнее: Работа с клавиатурами
system `boolean`	Системное сообщение. Допустимые значения: `true`, `false`. По умолчанию `false`
urlPreview `boolean`	Показывать превью ссылок. Допустимые значения: `true`, `false`. По умолчанию `true`

Примеры кода

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

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","commandId":42,"messageId":789,"dialogId":"chat5","fields":{"message":"Here is the help text..."}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.answer

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"commandId":42,"messageId":789,"dialogId":"chat5","fields":{"message":"Here is the help text..."},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Command.answer

try {
          const response = await $b24.callMethod('imbot.v2.Command.answer', {
            botId: 456,
            commandId: 42,
            messageId: 789,
            dialogId: 'chat5',
            fields: { message: 'Here is the help text...' },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Command.answer',
                    [
                        'botId' => 456,
                        'commandId' => 42,
                        'messageId' => 789,
                        'dialogId' => 'chat5',
                        'fields' => ['message' => 'Here is the help text...'],
                    ]
                );
        
            $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.answer',
            {
                botId: 456,
                commandId: 42,
                messageId: 789,
                dialogId: 'chat5',
                fields: { message: 'Here is the help text...' },
            },
            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.answer',
            [
                'botId' => 456,
                'commandId' => 42,
                'messageId' => 789,
                'dialogId' => 'chat5',
                'fields' => ['message' => 'Here is the help text...'],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Answer sent';
        }

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

HTTP-код: 200

{
            "result": true,
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+03:00",
                "date_finish": "2024-10-11T10:00:00+03:00"
            }
        }

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

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

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

HTTP-статус: 400, 403

{
            "error": "COMMAND_ANSWER_FAILED",
            "error_description": "Command answer failed"
        }

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

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

Код	Описание	Значение
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	Не указан `botToken`. Обязателен при авторизации через вебхук
`BOT_ID_REQUIRED`	Bot ID is required	Не указан `botId`
`BOT_NOT_FOUND`	Bot not found	Бот не найден
`BOT_OWNERSHIP_ERROR`	Bot is registered by another application	Бот зарегистрирован другим приложением
`COMMAND_ANSWER_FAILED`	Command answer failed	Ошибка отправки ответа

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

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.v2.Command.answer

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

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