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

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

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

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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.command.update", b24.Params{
	"COMMAND_ID": 99,
	"FIELDS": b24.Params{
		"COMMAND":           "echo2",
		"EVENT_COMMAND_ADD": "https://example.com/bot/command.php",
		"HIDDEN":            "N",
		"EXTRANET_SUPPORT":  "Y",
		"LANG": []b24.Params{
			{
				"LANGUAGE_ID": "ru",
				"TITLE":       "Эхо 2",
				"PARAMS":      "текст",
			},
			{
				"LANGUAGE_ID": "en",
				"TITLE":       "Echo 2",
				"PARAMS":      "text",
			},
		},
	},
	"CLIENT_ID": "**put_your_client_id_here**",
})
if err != nil {
	return fmt.Errorf("imbot.command.update: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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
string

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

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

Код

Описание

Значение

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-статус: 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

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

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