метод REST scope: imbot Устаревший

imbot.register

Создать чат-бота

Устаревший метод. Развитие метода остановлено. Используйте 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

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

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

Ответ

{
    "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
    }
}

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

HTTP-статус: 400

{
    "error": "CODE_ERROR",
    "error_description": "Bot code isn't specified"
}
Код Описание Значение
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 Бот не может быть создан

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

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