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

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

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

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

Boolean-параметры принимают true и false. Если клиент не поддерживает JSON boolean, можно передавать строки "Y" и "N".

Примеры кода

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

Пример 1. Обновление переводов

Обновить заголовок на ru и en. Переводы на других языках, если они были, останутся без изменений.

cURL (Webhook)

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

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

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

try {
  const response = await $b24.callMethod('imbot.v2.Command.update', {
    botId: 456,
    commandId: 42,
    fields: {
      title: {
        en: 'Updated help',
        ru: 'Обновленная помощь',
      },
    },
  });

  const { result } = response.getData();
  console.log('result:', result);
} catch (error) {
  console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imbot.v2.command.update(
        bot_id=456,
        command_id=42,
        fields={
            "title": {
                "en": "Updated help",
                "ru": "Обновленная команда",
            },
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.v2.Command.update',
            [
                'botId' => 456,
                'commandId' => 42,
                'fields' => [
                    'title' => [
                        'en' => 'Updated help',
                        'ru' => 'Обновленная помощь',
                    ],
                ],
            ]
        );

    $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.update',
    {
        botId: 456,
        commandId: 42,
        fields: {
            title: {
                en: 'Updated help',
                ru: 'Обновленная помощь',
            },
        },
    },
    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.update',
    [
        'botId' => 456,
        'commandId' => 42,
        'fields' => [
            'title' => [
                'en' => 'Updated help',
                'ru' => 'Обновленная помощь',
            ],
        ],
    ]
);

if (!empty($result['error'])) {
    echo 'Error: '. $result['error_description'];
} else {
    echo 'result: '. print_r($result['result'], true);
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Command.update", b24.Params{
	"botId":     456,
	"botToken":  "b15f6e80ef345c97e23db31e727281f4",
	"commandId": 42,
	"fields": b24.Params{
		"title": b24.Params{
			"en": "Updated help",
			"ru": "Обновленная помощь",
		},
	},
})
if err != nil {
	return fmt.Errorf("imbot.v2.Command.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "command".
raw, ok := b24.Unwrap(res.Result, "command")
if !ok {
	return fmt.Errorf("в ответе нет ключа command")
}

var item struct {
	ID              b24.ID `json:"id"`
	BotID           b24.ID `json:"botId"`
	Command         string `json:"command"`
	Common          bool   `json:"common"`
	Hidden          bool   `json:"hidden"`
	ExtranetSupport bool   `json:"extranetSupport"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.BotID)

Пример 2. Удаление перевода

Обновить ru и удалить en. Для удаления передайте null в качестве значения.

cURL (Webhook)

cURL (OAuth)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"b15f6e80ef345c97e23db31e727281f4","commandId":42,"fields":{"title":{"ru":"Помощь","en":null}}}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.update

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"commandId":42,"fields":{"title":{"ru":"Помощь","en":null}},"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imbot.v2.Command.update

try {
  const response = await $b24.callMethod('imbot.v2.Command.update', {
    botId: 456,
    commandId: 42,
    fields: {
      title: {
        ru: 'Помощь',
        en: null,
      },
    },
  });

  const { result } = response.getData();
  console.log('result:', result);
} catch (error) {
  console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imbot.v2.command.update(
        bot_id=456,
        bot_token="b15f6e80ef345c97e23db31e727281f4",
        command_id=42,
        fields={
            "title": {
                "ru": "Помощь",
                "en": None,
            },
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.v2.Command.update',
            [
                'botId' => 456,
                'commandId' => 42,
                'fields' => [
                    'title' => [
                        'ru' => 'Помощь',
                        'en' => null,
                    ],
                ],
            ]
        );

    $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.update',
    {
        botId: 456,
        commandId: 42,
        fields: {
            title: {
                ru: 'Помощь',
                en: null,
            },
        },
    },
    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.update',
    [
        'botId' => 456,
        'commandId' => 42,
        'fields' => [
            'title' => [
                'ru' => 'Помощь',
                'en' => null,
            ],
        ],
    ]
);

if (!empty($result['error'])) {
    echo 'Error: '. $result['error_description'];
} else {
    echo 'result: '. print_r($result['result'], true);
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Command.update", b24.Params{
	"botId":     456,
	"botToken":  "b15f6e80ef345c97e23db31e727281f4",
	"commandId": 42,
	"fields": b24.Params{
		"title": b24.Params{
			"ru": "Помощь",
			"en": nil,
		},
	},
})
if err != nil {
	return fmt.Errorf("imbot.v2.Command.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "command".
raw, ok := b24.Unwrap(res.Result, "command")
if !ok {
	return fmt.Errorf("в ответе нет ключа command")
}

var item struct {
	ID              b24.ID `json:"id"`
	BotID           b24.ID `json:"botId"`
	Command         string `json:"command"`
	Common          bool   `json:"common"`
	Hidden          bool   `json:"hidden"`
	ExtranetSupport bool   `json:"extranetSupport"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.BotID)

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

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"
    }
}

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

Название `Тип`	Описание
result `object`	Результат операции
result.command `Command`	Объект обновленной команды (подробное описание)
time `time`	Информация о времени выполнения запроса

Поля объекта Command

Поле `Тип`	Описание
id `integer`	Идентификатор команды
botId `integer`	Идентификатор бота
command `string`	Текст команды
common `boolean`	Команда доступна во всех чатах
hidden `boolean`	Команда скрыта из списка команд
extranetSupport `boolean`	Команда доступна экстранет-пользователям

Полное описание всех полей объектов — на странице Объекты и поля

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

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

{
    "error": "COMMAND_NOT_FOUND",
    "error_description": "Command not found"
}

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

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

Код	Описание	Значение
`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	Команда с таким именем уже зарегистрирована у этого бота

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

Зарегистрировать команду

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

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

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

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

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

Пример 1. Обновление переводовПример 1. Обновление переводов

Пример 2. Удаление переводаПример 2. Удаление перевода

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

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

Поля объекта CommandПоля объекта Command

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

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

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

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