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

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 `string`	Общая команда. Допустимые значения: `Y`, `N`
hidden `string`	Скрытая команда. Допустимые значения: `Y`, `N`
extranetSupport `string`	Поддержка экстранет. Допустимые значения: `Y`, `N`

Примеры кода

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

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

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

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":"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);
        }

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);
        }

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

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

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":"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);
        }

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);
        }

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

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`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`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-статус: 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.update

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

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

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

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

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

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

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

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

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

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

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

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