Зарегистрировать бота imbot.v2.Bot.register

Scope: imbot

Кто может выполнять метод: авторизованный пользователь

Метод imbot.v2.Bot.register регистрирует нового чат-бота.

Метод идемпотентен: повторный вызов с тем же fields.code от того же приложения возвращает существующего бота без обновления данных. Для обновления используйте imbot.v2.Bot.update.

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

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

Название `Тип`	Описание
fields* `object`	Объект с параметрами бота. Описание параметров — ниже

Параметр fields

Название `Тип`	Описание
code* `string`	Уникальный код бота в рамках приложения
botToken `string`	Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передайте уникальный botToken — этот ключ будет привязан к чат-боту и потребуется для всех последующих вызовов imbot.v2* через вебхук
properties* `object`	Свойства профиля бота. Описание параметров — ниже
type `string`	Тип бота. Описание типов и их поведения — Типы ботов. Значение по умолчанию: `bot`
eventMode `string`	Режим доставки событий. Допустимые значения: `fetch` — бот забирает события через imbot.v2.Event.get `webhook` — события отправляются POST-запросом на `webhookUrl` Значение по умолчанию: `fetch`
webhookUrl `string`	URL обработчика событий бота. Обязателен при `eventMode = webhook`
isHidden `boolean`	Скрытый бот. Допустимые значения: `true`, `false`. По умолчанию `false`
isReactionsEnabled `boolean`	Включить поддержку реакций. Допустимые значения: `true`, `false`. По умолчанию `true`
isSupportOpenline `boolean`	Включить поддержку Открытых линий. Допустимые значения: `true`, `false`. По умолчанию `false`
backgroundId `string`	Фон чата бота. По умолчанию `null` — используется фон из настроек пользователя. Доступные значения — в таблице фонов

Параметр properties

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

Доступные фоны

ID	Тема	Цвет
`azure`	dark	Голубой
`mint`	dark	Мятный
`steel`	dark	Стальной
`slate`	dark	Сланцевый
`teal`	dark	Бирюзовый
`cornflower`	dark	Васильковый
`sky`	light	Небесный
`peach`	light	Персиковый
`frost`	light	Морозный

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields":{
              "code":"support_bot",
              "botToken":"my_bot_token",
              "properties":{"name":"Support Bot","workPosition":"AI Assistant"},
              "type":"bot",
              "eventMode":"fetch"
            }
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Bot.register

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields":{
              "code":"support_bot",
              "properties":{"name":"Support Bot","workPosition":"AI Assistant"},
              "type":"bot",
              "eventMode":"fetch"
            },
            "auth":"**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Bot.register

try {
          const response = await $b24.callMethod('imbot.v2.Bot.register', {
            fields: {
              code: 'support_bot',
              properties: {
                name: 'Support Bot',
                workPosition: 'AI Assistant',
              },
              type: 'bot',
              eventMode: 'fetch',
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Bot.register',
                    [
                        'fields' => [
                            'code' => 'support_bot',
                            'properties' => [
                                'name' => 'Support Bot',
                                'workPosition' => 'AI Assistant',
                            ],
                            'type' => 'bot',
                            'eventMode' => 'fetch',
                        ],
                    ]
                );
        
            $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.register',
            {
                fields: {
                    code: 'support_bot',
                    properties: {
                        name: 'Support Bot',
                        workPosition: 'AI Assistant',
                    },
                    type: 'bot',
                    eventMode: 'fetch',
                },
            },
            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.register',
            [
                'fields' => [
                    'code' => 'support_bot',
                    'properties' => [
                        'name' => 'Support Bot',
                        'workPosition' => 'AI Assistant',
                    ],
                    'type' => 'bot',
                    'eventMode' => 'fetch',
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'Bot ID: '. $result['result']['bot']['id'];
        }

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

HTTP-код: 200

{
            "result": {
                "bot": {
                    "id": 456,
                    "code": "support_bot",
                    "type": "bot",
                    "isHidden": false,
                    "isSupportOpenline": false,
                    "isReactionsEnabled": true,
                    "backgroundId": null,
                    "language": "en",
                    "moduleId": "rest",
                    "appId": "local.67890abcdef12.34567890",
                    "eventMode": "fetch",
                    "countMessage": 0,
                    "countCommand": 0,
                    "countChat": 0,
                    "countUser": 0
                },
                "users": [
                    {
                        "id": 456,
                        "active": true,
                        "name": "Support Bot",
                        "firstName": "Support",
                        "lastName": "Bot",
                        "workPosition": "AI Assistant",
                        "color": "#df532d",
                        "avatar": "",
                        "gender": "M",
                        "birthday": "",
                        "extranet": false,
                        "bot": true,
                        "connector": false,
                        "externalAuthId": "bot",
                        "status": "online",
                        "idle": false,
                        "lastActivityDate": "2025-01-15T10:30:00+03:00",
                        "absent": false,
                        "departments": [1],
                        "phones": false,
                        "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`	Имя и фамилия пользователя
firstName `string`	Имя пользователя
lastName `string`	Фамилия пользователя
workPosition `string`	Должность
color `string`	Цвет пользователя
avatar `string`	URL аватара
gender `string`	Пол пользователя
birthday `string`	Дата рождения
extranet `boolean`	Пользователь экстранета
bot `boolean`	Признак пользователя-бота
connector `boolean`	Пользователь подключен через коннектор
externalAuthId `string`	Внешний тип авторизации
status `string`	Статус пользователя
idle `boolean`	Пользователь неактивен
lastActivityDate `string`	Дата последней активности
absent `boolean`	Пользователь отсутствует
departments `array`	Список подразделений
phones `array`	Список телефонов
type `string`	Тип пользователя

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

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

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

{
            "error": "BOT_CODE_REQUIRED",
            "error_description": "Bot code is required"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	Не указан `fields.botToken`. Обязателен при авторизации через вебхук
`BOT_CODE_REQUIRED`	Bot code is required	Не указан код бота (`fields.code`)
`BOT_PROPERTIES_REQUIRED`	Bot properties are required	Не указаны свойства бота (имя)
`BOT_CODE_ALREADY_TAKEN`	Bot code is already taken	Код бота уже занят другим приложением
`BOT_INVALID_TYPE`	Invalid bot type	Невалидный тип бота. Допустимые значения: `bot`, `network`, `openline`, `supervisor`, `personal`
`BOT_INVALID_EVENT_MODE`	Invalid event mode	Невалидный режим доставки событий. Допустимые значения: `fetch`, `webhook`
`BOT_WEBHOOK_URL_REQUIRED`	Webhook URL is required	Не указан `fields.webhookUrl` при `fields.eventMode = webhook`
`BOT_REGISTER_FAILED`	Bot registration failed	Ошибка регистрации бота
`BOT_INVALID_CALLBACK`	Invalid callback URL	Невалидный URL обработчика
`BOT_LIMIT_EXCEEDED`	Bot limit exceeded	Превышен лимит ботов приложения (100 ботов)
`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.register

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

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

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

Доступные фоныДоступные фоны

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

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

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

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

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

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

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

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

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