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

Scope: imbot

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

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Command.update.

Метод imbot.command.update обновляет параметры зарегистрированной команды чат-бота.

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

Обязательные параметры отмечены *

Название
тип

Описание

COMMAND_ID*
integer

Идентификатор команды для обновления

FIELDS*
object

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

CLIENT_ID
string

Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

В FIELDS должен быть передан хотя бы один изменяемый параметр. Если передать пустой объект, метод вернет ошибку

Параметр FIELDS

Название
тип

Описание

COMMAND
string

Текст команды

EVENT_COMMAND_ADD
string

URL обработчика события ONIMCOMMANDADD

HIDDEN
string

Видимость команды:

  • Y - скрытая
  • N - видимая

EXTRANET_SUPPORT
string

Доступность для пользователей экстранета:

  • Y - доступна
  • N - недоступна

LANG
array

Массив локализаций команды. Структура описана ниже

Параметр FIELDS.LANG

Название
тип

Описание

LANGUAGE_ID*
string

Идентификатор языка, например ru или en

TITLE*
string

Название команды на выбранном языке

PARAMS
string

Подсказка по параметрам команды на выбранном языке

Примеры кода

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

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"COMMAND_ID":99,"FIELDS":{"COMMAND":"echo2","EVENT_COMMAND_ADD":"https://example.com/bot/command.php","HIDDEN":"N","EXTRANET_SUPPORT":"Y","LANG":[{"LANGUAGE_ID":"ru","TITLE":"Эхо 2","PARAMS":"текст"},{"LANGUAGE_ID":"en","TITLE":"Echo 2","PARAMS":"text"}]},"CLIENT_ID":"**put_your_client_id_here**"}' /
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.command.update
        
curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"COMMAND_ID":99,"FIELDS":{"COMMAND":"echo2","EVENT_COMMAND_ADD":"https://example.com/bot/command.php","HIDDEN":"N","EXTRANET_SUPPORT":"Y","LANG":[{"LANGUAGE_ID":"ru","TITLE":"Эхо 2","PARAMS":"текст"},{"LANGUAGE_ID":"en","TITLE":"Echo 2","PARAMS":"text"}]},"auth":"**put_access_token_here**"}' /
        https://**put_your_bitrix24_address**/rest/imbot.command.update
        
try
        {
            const response = await $b24.callMethod(
                'imbot.command.update',
                {
                    COMMAND_ID: 99,
                    FIELDS: {
                        COMMAND: 'echo2',
                        EVENT_COMMAND_ADD: 'https://example.com/bot/command.php',
                        HIDDEN: 'N',
                        EXTRANET_SUPPORT: 'Y',
                        LANG: [
                            { LANGUAGE_ID: 'ru', TITLE: 'Эхо 2', PARAMS: 'текст' },
                            { LANGUAGE_ID: 'en', TITLE: 'Echo 2', PARAMS: 'text' }
                        ]
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Updated command with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.command.update',
                    [
                        'COMMAND_ID' => 99,
                        'FIELDS' => [
                            'COMMAND' => 'echo2',
                            'EVENT_COMMAND_ADD' => 'https://example.com/bot/command.php',
                            'HIDDEN' => 'N',
                            'EXTRANET_SUPPORT' => 'Y',
                            'LANG' => [
                                ['LANGUAGE_ID' => 'ru', 'TITLE' => 'Эхо 2', 'PARAMS' => 'текст'],
                                ['LANGUAGE_ID' => 'en', 'TITLE' => 'Echo 2', 'PARAMS' => 'text']
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating command: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'imbot.command.update',
            {
                COMMAND_ID: 99,
                FIELDS: {
                    COMMAND: 'echo2',
                    EVENT_COMMAND_ADD: 'https://example.com/bot/command.php',
                    HIDDEN: 'N',
                    EXTRANET_SUPPORT: 'Y',
                    LANG: [
                        { LANGUAGE_ID: 'ru', TITLE: 'Эхо 2', PARAMS: 'текст' },
                        { LANGUAGE_ID: 'en', TITLE: 'Echo 2', PARAMS: 'text' }
                    ]
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.command.update',
            [
                'COMMAND_ID' => 99,
                'FIELDS' => [
                    'COMMAND' => 'echo2',
                    'EVENT_COMMAND_ADD' => 'https://example.com/bot/command.php',
                    'HIDDEN' => 'N',
                    'EXTRANET_SUPPORT' => 'Y',
                    'LANG' => [
                        ['LANGUAGE_ID' => 'ru', 'TITLE' => 'Эхо 2', 'PARAMS' => 'текст'],
                        ['LANGUAGE_ID' => 'en', 'TITLE' => 'Echo 2', 'PARAMS' => 'text']
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1772103002,
                "finish": 1772103003.109342,
                "duration": 1.109342098236084,
                "processing": 0,
                "date_start": "2026-02-26T13:50:02+03:00",
                "date_finish": "2026-02-26T13:50:03+03:00",
                "operating_reset_at": 1772103603,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
boolean

true, если команда успешно обновлена

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "WRONG_REQUEST",
            "error_description": "Update fields can't be empty"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

COMMAND_ID_ERROR

Command not found

Команда не найдена

APP_ID_ERROR

Command was installed by another rest application

Команда зарегистрирована другим приложением

EVENT_COMMAND_ADD_ERROR

Wrong handler URL

Невалидный URL обработчика события команды

WRONG_REQUEST

Update fields can't be empty

Не переданы поля для обновления

WRONG_REQUEST

Command can't be updated

Не удалось обновить команду

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

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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