Обновить бота imbot.v2.Bot.update

Scope: imbot

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

Метод 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` для сброса на фон пользователя. Доступные значения — в таблице фонов
eventMode `string`	Режим доставки событий: `fetch` или `webhook`
webhookUrl `string`	URL обработчика событий (применяется при `eventMode = webhook`)

Параметр properties

Название `Тип`	Описание
name `string`	Имя бота
lastName `string`	Фамилия бота
workPosition `string`	Должность бота (отображается в профиле)
color `string`	Цвет аватара, доступные цвета. Если указан некорректно — игнорируется
gender `string`	Пол. Допустимые значения: `M`, `F`
avatar `file`	Аватар. Передавайте строку Base64 без префикса `data:/;base64,`. Как подготовить данные: Как загружать файлы

Примеры кода

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

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":"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

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

try {
          const response = await $b24.callMethod('imbot.v2.Bot.update', {
            botId: 456,
            fields: {
              properties: { name: 'Updated Bot' },
              isHidden: true,
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Bot.update',
                    [
                        'botId' => 456,
                        'fields' => [
                            'properties' => ['name' => 'Updated Bot'],
                            'isHidden' => true,
                        ],
                    ]
                );
        
            $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.Bot.update',
            {
                botId: 456,
                fields: {
                    properties: { name: 'Updated Bot' },
                    isHidden: true,
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Bot.update',
            [
                'botId' => 456,
                'fields' => [
                    'properties' => ['name' => 'Updated Bot'],
                    'isHidden' => true,
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'Success';
        }

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

HTTP-код: 200

{
            "result": {
                "bot": {
                    "id": 456,
                    "code": "support_bot",
                    "type": "bot",
                    "isHidden": true,
                    "isSupportOpenline": false,
                    "isReactionsEnabled": true,
                    "backgroundId": null,
                    "language": "ru",
                    "moduleId": "rest",
                    "appId": "local.67890abcdef12.34567890",
                    "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"
            }
        }

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

Название `Тип`	Описание
result `object`	Результат обновления
result.bot `Bot`	Обновленный объект бота в расширенном формате (подробное описание)
result.users `User[]`	Массив связанных пользователей (подробное описание)
time `time`	Информация о времени выполнения запроса

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

Поле `Тип`	Описание
id `integer`	Идентификатор бота
code `string`	Символьный код бота
type `string`	Тип бота
isHidden `boolean`	Бот скрыт от списка контактов
isSupportOpenline `boolean`	Бот поддерживает открытые линии
isReactionsEnabled `boolean`	Для сообщений бота включены реакции
backgroundId `integer`	Идентификатор фона чата
language `string`	Язык бота
moduleId `string`	Идентификатор модуля
appId `integer`	Идентификатор приложения или `0`, если бот не привязан к приложению
eventMode `string`	Режим доставки событий: `webhook` или `fetch`
countMessage `integer`	Количество сообщений, отправленных ботом
countCommand `integer`	Количество зарегистрированных команд
countChat `integer`	Количество чатов бота
countUser `integer`	Количество пользователей, взаимодействовавших с ботом

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

Поле `Тип`	Описание
id `integer`	Идентификатор пользователя
active `boolean`	Пользователь активен
name `string`	Имя и фамилия пользователя
bot `boolean`	Признак пользователя-бота
type `string`	Тип пользователя

Полное описание всех полей объектов — на странице Объекты и поля

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

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

{
            "error": "BOT_NOT_FOUND",
            "error_description": "Bot 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	Бот зарегистрирован другим приложением
`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)

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

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.Bot.update

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

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

Параметр propertiesПараметр properties

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

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

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

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

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

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

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

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

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