метод REST scope: imbot

imbot.v2.Command.answer

Ответить на команду

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

Описание

Метод 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 -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

Ответ

HTTP-статус: 200

{
    "result": {
        "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"
    }
}

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

HTTP-статус: 400

{
    "error": "COMMAND_ANSWER_FAILED",
    "error_description": "Command answer failed"
}
Код Описание Значение
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 Ошибка отправки ответа

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.