метод REST scope: imbot

imbot.v2.Command.update

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

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

Описание

Метод imbot.v2.Command.update обновляет слэш-команду бота.

Параметры

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

ID бота

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

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

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

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

ID команды

fields object обязательный

Обновляемые поля команды. Структура объекта описана ниже

Параметр fields

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

Новая команда (без /)

title object необязательный

Заголовок команды на разных языках:

  • строковое значение обновляет перевод
  • значение null удаляет перевод
  • отсутствие ключа оставляет перевод без изменений

Пример: {"ru": "Новый", "en": null} обновит ru и удалит en

params object необязательный

Описание параметров на разных языках. Аналогично title, применяется только к тем языкам, которые переданы в title

common boolean необязательный

Общая команда. Допустимые значения: true, false

hidden boolean необязательный

Скрытая команда. Допустимые значения: true, false

extranetSupport boolean необязательный

Поддержка экстранет. Допустимые значения: true, false

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"b15f6e80ef345c97e23db31e727281f4","commandId":42,"fields":{"title":{"en":"Updated help","ru":"Обновленная помощь"}}}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.update

Ответ

HTTP-статус: 200

{
    "result": {
        "command": {
            "id": 42,
            "botId": 456,
            "command": "/help",
            "common": false,
            "hidden": false,
            "extranetSupport": false
        }
    },
    "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_NOT_FOUND",
    "error_description": "Command 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 Бот зарегистрирован другим приложением
COMMAND_NOT_FOUND Command not found Команда не найдена или нет доступа
COMMAND_NAME_EMPTY Command name is empty Передано пустое имя команды
COMMAND_NAME_INVALID Command name is invalid Имя команды должно быть строкой
COMMAND_ALREADY_EXISTS Command already exists Команда с таким именем уже зарегистрирована у этого бота

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

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