Обновить чат-бота imbot.update

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

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

Scope: imbot

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

DEPRECATED

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

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

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

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

Название
Тип

Описание

BOT_ID*
integer

Идентификатор чат-бота. Получить идентификатор можно методом imbot.bot.list. Значение должно быть больше 0

FIELDS*
object

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

CLIENT_ID
string

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

Параметр FIELDS

Название
Тип

Описание

CODE
string

Новый строковый код бота, уникальный в рамках Битрикс24

EVENT_HANDLER
string

Общий URL обработчика событий. Если передан, его значение копируется в EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE, EVENT_MESSAGE_DELETE, EVENT_WELCOME_MESSAGE, EVENT_BOT_DELETE.

Если нужны разные обработчики, не передавайте EVENT_HANDLER. Задайте отдельные URL в параметрах EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE, EVENT_MESSAGE_DELETE, EVENT_WELCOME_MESSAGE, EVENT_BOT_DELETE

EVENT_MESSAGE_ADD
string

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

EVENT_MESSAGE_UPDATE
string

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

EVENT_MESSAGE_DELETE
string

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

EVENT_WELCOME_MESSAGE
string

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

EVENT_BOT_DELETE
string

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

PROPERTIES
object

Свойства профиля чат-бота. Структура объекта подробно описана ниже

Метод imbot.update не поддерживает изменение полей TYPE и OPENLINE.

Параметр FIELDS.PROPERTIES

Название
Тип

Описание

NAME
string

Имя чат-бота. Если переданы оба значения: NAME и LAST_NAME, они не должны быть пустыми одновременно

LAST_NAME
string

Фамилия чат-бота. Если переданы оба значения: NAME и LAST_NAME, они не должны быть пустыми одновременно

COLOR
string

Цвет чат-бота для мобильного интерфейса: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE

EMAIL
string

Email для связи чат-бота. Бот создается как пользователь, поэтому email бота не должен совпадать с email реального пользователя Битрикс24. Это позволит избежать конфликтов учетных записей

PERSONAL_BIRTHDAY
string

День рождения в формате YYYY-MM-DD

WORK_POSITION
string

Должность или описание чат-бота

PERSONAL_WWW
string

Ссылка на сайт

PERSONAL_GENDER
string

Пол, допустимые значения: M или F

PERSONAL_PHOTO
file

Аватар чат-бота в формате Base64

Размер изображения не должен превышать ограничение в 5000x5000

Для обновления бота передайте хотя бы один параметр: поле в FIELDS или URL обработчика события. Если все параметры пустые, метод вернет ошибку WRONG_REQUEST.

Примеры кода

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

curl -X POST /
  -H "Content-Type: application/json" /
  -H "Accept: application/json" /
  -d '{"BOT_ID":39,"FIELDS":{"CODE":"newbot_v2","EVENT_HANDLER":"https://example.com/bot/events","PROPERTIES":{"NAME":"UpdatedBot","WORK_POSITION":"Updated description"}},"CLIENT_ID":"**put_your_client_id_here**"}' /
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.update

curl -X POST /
  -H "Content-Type: application/json" /
  -H "Accept: application/json" /
  -d '{"BOT_ID":39,"FIELDS":{"CODE":"newbot_v2","EVENT_HANDLER":"https://example.com/bot/events","PROPERTIES":{"NAME":"UpdatedBot"}},"auth":"**put_access_token_here**"}' /
  https://**put_your_bitrix24_address**/rest/imbot.update

try {
  const response = await $b24.callMethod('imbot.update', {
    BOT_ID: 39,
    FIELDS: {
      CODE: 'newbot_v2',
      EVENT_HANDLER: 'https://example.com/bot/events',
      PROPERTIES: {
        NAME: 'UpdatedBot',
        WORK_POSITION: 'Updated description',
      },
    },
  });

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

try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.update',
            [
                'BOT_ID' => 39,
                'FIELDS' => [
                    'CODE' => 'newbot_v2',
                    'EVENT_HANDLER' => 'https://example.com/bot/events',
                    'PROPERTIES' => [
                        'NAME' => 'UpdatedBot',
                        'WORK_POSITION' => 'Updated description',
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Updated: ' . ($result->data() ? 'true' : 'false');
    }
} catch (Throwable $exception) {
    error_log($exception->getMessage());
    echo 'Error updating bot: ' . $exception->getMessage();
}

BX24.callMethod(
    'imbot.update',
    {
        BOT_ID: 39,
        FIELDS: {
            CODE: 'newbot_v2',
            EVENT_HANDLER: 'https://example.com/bot/events',
            PROPERTIES: {
                NAME: 'UpdatedBot',
                WORK_POSITION: 'Updated description',
            },
        },
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'imbot.update',
    [
        'BOT_ID' => 39,
        'FIELDS' => [
            'CODE' => 'newbot_v2',
            'EVENT_HANDLER' => 'https://example.com/bot/events',
            'PROPERTIES' => [
                'NAME' => 'UpdatedBot',
                'WORK_POSITION' => 'Updated description',
            ],
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.update", b24.Params{
	"BOT_ID": 39,
	"FIELDS": b24.Params{
		"CODE":          "newbot_v2",
		"EVENT_HANDLER": "https://example.com/bot/events",
		"PROPERTIES": b24.Params{
			"NAME":          "UpdatedBot",
			"WORK_POSITION": "Updated description",
		},
	},
	"CLIENT_ID": "**put_your_client_id_here**",
})
if err != nil {
	return fmt.Errorf("imbot.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": 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",
        "operating_reset_at": 1762349466,
        "operating": 0
    }
}

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

Название
Тип

Описание

result
boolean

true, если бот обновлен без ошибки

time
time

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

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

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

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

WRONG_AUTH_TYPE

Access for this method not allowed by session authorization.

Метод вызван с сессионной авторизацией вместо OAuth или вебхука

ACCESS_DENIED

Access denied! Client ID not specified

Не удалось определить приложение: отсутствует clientId авторизации и не передан CLIENT_ID

BOT_ID_ERROR

Bot not found

Бот не найден

APP_ID_ERROR

Bot was installed by another rest application

Переданный BOT_ID принадлежит другому приложению

EVENT_MESSAGE_ADD_ERROR

Wrong handler URL

Передан невалидный URL обработчика EVENT_MESSAGE_ADD

EVENT_MESSAGE_UPDATE_ERROR

Wrong handler URL

Передан невалидный URL обработчика EVENT_MESSAGE_UPDATE

EVENT_MESSAGE_DELETE_ERROR

Wrong handler URL

Передан невалидный URL обработчика EVENT_MESSAGE_DELETE

EVENT_WELCOME_MESSAGE_ERROR

Wrong handler URL

Передан невалидный URL обработчика EVENT_WELCOME_MESSAGE

EVENT_BOT_DELETE_ERROR

Wrong handler URL

Передан невалидный URL обработчика EVENT_BOT_DELETE

NAME_ERROR

Bot name isn't specified

В PROPERTIES переданы оба пустых поля: NAME и LAST_NAME

WRONG_REQUEST

Update fields can't be empty

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

WRONG_REQUEST

Bot 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

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

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

Предыдущая
Создать чат-бота
Следующая
Получить список чат-ботов