Создать чат-бота imbot.register

Scope: imbot

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

DEPRECATED

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

Метод imbot.register регистрирует чат-бота и привязывает обработчики событий приложения.

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

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

Название `Тип`	Описание
CODE* `string`	Строковый код бота, уникальный в рамках Битрикс24
TYPE `string`	Тип бота. Допустимые значения: `B` — стандартный чат-бот. В групповых чатах видит сообщения, которые адресованы именно ему. `O` — чат-бот для Открытых линий. `H` — чат-бот в режиме «человек» (human). Перед автоответом включает статус «печатает...» `startWriting`. `S` — чат-бот с повышенными привилегиями (supervisor). Читает все сообщения в чатах, в которых состоит. Если бота добавили с показом истории, он видит старые и новые сообщения. Если без истории — только новые сообщения. Значение по умолчанию: `B`
OPENLINE `string`	Режим работы с Открытыми линиями. Допустимые значения: `Y` — включить режим поддержки Открытых линий `N` — отключить, значение по умолчанию Для `TYPE=O` параметр можно не указывать. Значение будет принудительно установлено в `Y`
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. Параметр игнорируется только для ботов с `TYPE=B/H` и `OPENLINE=N`
EVENT_MESSAGE_DELETE `string`	URL обработчика события ONIMBOTMESSAGEDELETE. Параметр игнорируется только для ботов с `TYPE=B/H` и `OPENLINE=N`
EVENT_WELCOME_MESSAGE* `string`	URL обработчика события ONIMBOTJOINCHAT
EVENT_BOT_DELETE* `string`	URL обработчика события ONIMBOTDELETE
CLIENT_ID `string`	Параметр обязателен только для вебхуков. Передайте уникальный CLIENT_ID — этот ключ будет привязан к чат-боту и потребуется для всех последующих вызовов imbot* через вебхук
PROPERTIES* `object`	Свойства профиля чат-бота. Структура объекта подробно описана ниже

Параметр 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

Если логика приложения позволяет, отправляйте ответ боту при явном упоминании. Проверить это можно по полю TO_USER_ID.

В одном приложении можно использовать только один набор URL обработчиков событий.

Если регистрируете второго бота, параметры EVENT_MESSAGE_ADD, EVENT_WELCOME_MESSAGE и EVENT_BOT_DELETE должны совпадать с первым ботом.

Если в приложении несколько ботов, различайте их внутри одного обработчика событий. В событие передавайте массив ботов.

Максимальное количество ботов для одного приложения: 5

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"CODE":"newbot","TYPE":"B","EVENT_HANDLER":"https://example.ru/bot/events","OPENLINE":"N","PROPERTIES":{"NAME":"NewBot","WORK_POSITION":"Support bot"},"CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.register

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"CODE":"newbot","TYPE":"B","EVENT_HANDLER":"https://example.ru/bot/events","OPENLINE":"N","PROPERTIES":{"NAME":"NewBot"},"auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.register

try {
          const response = await $b24.callMethod('imbot.register', {
            CODE: 'newbot',
            TYPE: 'B',
            EVENT_HANDLER: 'https://example.ru/bot/events',
            OPENLINE: 'N',
            PROPERTIES: {
              NAME: 'NewBot',
              WORK_POSITION: 'Support bot',
            },
          });
        
          const { result } = response.getData();
          console.log('Created bot ID:', result);
        } catch (error) {
          console.error('Error registering bot:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.register',
                    [
                        'CODE' => 'newbot',
                        'TYPE' => 'B',
                        'EVENT_HANDLER' => 'https://example.ru/bot/events',
                        'OPENLINE' => 'N',
                        'PROPERTIES' => [
                            'NAME' => 'NewBot',
                            'WORK_POSITION' => 'Support bot',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Created bot ID: ' . $result->data();
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error registering bot: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imbot.register',
            {
                CODE: 'newbot',
                TYPE: 'B',
                EVENT_HANDLER: 'https://example.ru/bot/events',
                OPENLINE: 'N',
                PROPERTIES: {
                    NAME: 'NewBot',
                    WORK_POSITION: 'Support bot',
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.register',
            [
                'CODE' => 'newbot',
                'TYPE' => 'B',
                'EVENT_HANDLER' => 'https://example.ru/bot/events',
                'OPENLINE' => 'N',
                'PROPERTIES' => [
                    'NAME' => 'NewBot',
                    'WORK_POSITION' => 'Support bot',
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Created bot ID: ' . $result['result'];
        }

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

HTTP-код: 200

{
            "result": 39,
            "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 `integer`	Идентификатор созданного чат-бота `BOT_ID`
time `time`	Информация о времени выполнения запроса

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

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

{
            "error": "CODE_ERROR",
            "error_description": "Bot code isn't specified"
        }

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

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

Код	Описание	Значение
`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization	Метод вызван с сессионной авторизацией вместо OAuth или вебхука
`ACCESS_DENIED`	Access denied! Client ID not specified	Не удалось определить приложение: отсутствует `clientId` авторизации и не передан `CLIENT_ID`
`EVENT_MESSAGE_ADD_ERROR`	Handler for "Message add" event isn't specified	Не передан обязательный обработчик события `EVENT_MESSAGE_ADD`
`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`	Handler for "Welcome message" event isn't specified	Не передан обязательный обработчик события `EVENT_WELCOME_MESSAGE`
`EVENT_WELCOME_MESSAGE_ERROR`	Wrong handler URL	Передан невалидный URL `EVENT_WELCOME_MESSAGE`
`EVENT_BOT_DELETE_ERROR`	Handler for "Bot delete" event isn't specified	Не передан обязательный обработчик события `EVENT_BOT_DELETE`
`EVENT_BOT_DELETE_ERROR`	Wrong handler URL	Передан невалидный URL `EVENT_BOT_DELETE`
`CODE_ERROR`	Bot code isn't specified	Не передан обязательный код бота `CODE`
`NAME_ERROR`	Bot name isn't specified	В `PROPERTIES` не указано одно из обязательных полей: `NAME` или `LAST_NAME`
`MAX_COUNT_ERROR`	Has reached the maximum number of bots for application (max: N)	Достигнуто ограничение на количество ботов приложения
`WRONG_REQUEST`	Bot can't be created	Бот не может быть создан

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

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.register

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

Параметр PROPERTIESПараметр PROPERTIES

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

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

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

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

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

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

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