метод REST scope: imbot

imbot.v2.Command.list

Получить список команд

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

Описание

Метод imbot.v2.Command.list возвращает список всех команд бота.

Параметры

botId integer обязательный

ID бота

botToken string необязательный

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте тот же botToken, который был указан при регистрации чат-бота

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.list

Ответ

HTTP-статус: 200

{
    "result": {
        "commands": [
            {
                "id": 42,
                "botId": 456,
                "command": "/help",
                "title": "Показать помощь",
                "params": "текст запроса",
                "common": false,
                "hidden": false,
                "extranetSupport": false,
                "category": "My Bot",
                "context": ""
            }
        ]
    },
    "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": "BOT_NOT_FOUND",
    "error_description": "Bot not found"
}
Код Описание Значение
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 Бот зарегистрирован другим приложением

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

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