метод REST scope: imbot

imbot.v2.Bot.update

Обновить бота

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

Описание

Метод imbot.v2.Bot.update обновляет свойства бота.

Параметры

botId integer обязательный

ID бота

botToken string необязательный

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте тот же botToken, который был указан при регистрации чат-бота

fields object обязательный

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

Параметр fields

properties object необязательный

Свойства профиля бота. Описание параметров — ниже

isHidden boolean необязательный

Скрытый бот. Допустимые значения: true, false

isReactionsEnabled boolean необязательный

Поддержка реакций. Допустимые значения: true, false

isSupportOpenline boolean необязательный

Поддержка Открытых линий. Допустимые значения: true, false

backgroundId string необязательный

Фон чата бота. Передайте null для сброса на фон пользователя. Доступные значения — в таблице фонов. Невалидное значение нормализуется в null

eventMode string необязательный

Режим доставки событий: fetch или webhook

webhookUrl string необязательный

URL обработчика событий (применяется при eventMode = webhook)

botToken string необязательный

Новый botToken для ротации токена бота. Авторизация запроса выполняется старым токеном, переданным на верхнем уровне в параметре botToken. Пустая строка или строка из пробелов игнорируется. Максимальная длина — 40 символов.

Подробнее — в разделе Ротация botToken

Параметр properties

name string необязательный

Имя бота

lastName string необязательный

Фамилия бота

workPosition string необязательный

Должность бота (отображается в профиле)

color string необязательный

Цвет аватара, доступные цвета.
Если указан некорректно — игнорируется

gender string необязательный

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

avatar file необязательный

Аватар. Передавайте строку Base64 без префикса data:*/*;base64,.

Как подготовить данные: Как загружать файлы

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token","fields":{"properties":{"name":"Updated Bot"},"isHidden":true}}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Bot.update

Ответ

HTTP-статус: 200

{
    "result": {
        "bot": {
            "id": 456,
            "code": "support_bot",
            "type": "bot",
            "isHidden": true,
            "isSupportOpenline": false,
            "isReactionsEnabled": true,
            "backgroundId": null,
            "language": "ru",
            "moduleId": "rest",
            "eventMode": "fetch",
            "countMessage": 150,
            "countCommand": 3,
            "countChat": 12,
            "countUser": 45
        },
        "users": [
            {
                "id": 456,
                "active": true,
                "name": "Updated Bot",
                "bot": true,
                "type": "bot"
            }
        ]
    },
    "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"
    }
}

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

HTTP-статус: 400

{
    "error": "BOT_NOT_FOUND",
    "error_description": "Bot not found"
}
Код Описание Значение
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 Бот зарегистрирован другим приложением
BOT_INVALID_EVENT_MODE Invalid event mode Невалидный режим доставки событий
BOT_INVALID_CALLBACK Invalid callback URL Невалидный URL обработчика
BOT_AVATAR_INCORRECT_TYPE Avatar must be an image Аватар должен быть изображением (image/*)
BOT_AVATAR_INCORRECT_SIZE Avatar exceeds maximum size Размер аватара превышает максимум (5000×5000 px)
BOT_TOKEN_ROTATION_FAILED Bot token rotation failed Ротация botToken не выполнена. Обобщенный код ошибки — причина не раскрывается, чтобы не подтверждать существование чужих токенов

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.