Зарегистрировать приложение для чата imbot.app.register

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

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

Метод imbot.app.register регистрирует приложение для чата.

Приложения делятся на два типа: JS-команда и IFRAME-приложение.

Параметры метода для JS-команды

Название

Пример

Описание

BOT_ID

62

Идентификатор бота владельца приложения для чата

CODE

'echo'

Код приложения для чата

JS_METHOD

'SEND'

Варианты для JS_METHOD:

  • PUT — вставка команды чат-боту в textarea, JS_PARAM может содержать только текст команды и параметры к ней (разрешенные символы: a-z 0-9 - + _ / )
  • SEND — отправка команды чат-боту, JS_PARAMможет содержать только текст команды и параметры к ней (разрешенные символы a-z 0-9 - + _ / )
  • CALL — вызов телефонного номера
  • SUPPORT — открытие чат-бота техподдержки работающего через Открытые линии, в JS_PARAM необходимо указать код открытой линии (32 символа)

JS_PARAM

'/help'

ICON_FILE

'/* base64 image */'

Иконка в base64.
Формат иконки ICON_FILE:

  • В данное поле необходимо передать base64 от вашей иконки, формат иконки подробно описан в документации
  • Обратите внимание, если данное поле не указано, то приложение будет доступно в системном диалоге "Приложения для чата"

CONTEXT

'BOT'

Контекст приложения.
Контекст CONTEXT указывает, где будет доступно приложение:

  • ALL — во всех чатах
  • USER — только в чатах Один-на-один
  • CHAT — только в групповых чатах
  • BOT — только у чат-бота, который установил приложение
  • LINES — только в чатах Открытых линий
  • CALL — только в чатах, созданных в рамках Телефонии

К каждому контексту можно добавить постфикс -admin, тогда приложение будет доступно в нужном контексте только администраторам Битрикс24

EXTRANET_SUPPORT

'N'

Доступна ли команда пользователям экстранет, по умолчанию N

LIVECHAT_SUPPORT

'N'

Поддержка онлайн-чата

IFRAME_POPUP

'N'

iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно.

LANG

Array(...)

Массив переводов, желательно указывать как минимум для RU и EN

LANGUAGE_ID (LANG)

'en'

Идентификатор языка для перевода

TITLE (LANG)

'Echobot BUTTON'

Заголовок для кнопки или команды на указанном языке

DESCRIPTION (LANG)

'Send help command'

Описание команды на указанном языке

Пример кода

Примечание

В примере используется функция restCommand. Это метод отправки данных в Битрикс24. Другой пример использования метода вы найдете в примере ЭхоБота. Вы можете использовать для вызова метода свою функцию, javascript-метод BX24.callMethod или bitrix24-php-sdk.

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

$result = restCommand(
    'imbot.app.register',
    Array(
        'BOT_ID' => 62,
        'CODE' => 'echo',
        'JS_METHOD' => 'SEND',
        'JS_PARAM' => '/help',
        'ICON_FILE' => '/* base64 image */',
        'CONTEXT' => 'BOT',
        'EXTRANET_SUPPORT' => 'N',
        'LIVECHAT_SUPPORT' => 'N',
        'IFRAME_POPUP' => 'N',
        'LANG' => Array(
            Array(
                'LANGUAGE_ID' => 'en',
                'TITLE' => 'Echobot BUTTON',
                'DESCRIPTION' => 'Send help command'
            ),
        )
    ),
    $_REQUEST["auth"]
);

Параметры метода для IFRAME-приложения

Название

Пример

Описание

BOT_ID

62

Идентификатор бота владельца приложения для чата

CODE

'echo'

Код приложения для чата

IFRAME

'https://marta.bitrix24.tech/iframe/echo.php'

URL адрес фрейма

IFRAME_WIDTH

'350'

Желаемая ширина фрейма. Минимальное значение - 250px

IFRAME_HEIGHT

'150'

Желаемая высота фрейма. Минимальное значение - 50px

HASH

'd1ab17949a572b0979d8db0d5b349cd2'

Токен для доступа к вашему фрейму для проверки подписи, 32 символа

ICON_FILE

'/* base64 image */'

Иконка в base64

CONTEXT

'BOT'

Контекст

HIDDEN

'N'

Скрытое приложение или нет

EXTRANET_SUPPORT

'N'

Доступна ли команда пользователям экстранет, по умолчанию N

LIVECHAT_SUPPORT

'N'

Поддержка онлайн-чата

IFRAME_POPUP

'N'

iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно

LANG

Array(...)

Массив переводов, желательно указывать как минимум для RU и EN

LANGUAGE_ID (LANG)

'en'

Идентификатор языка для перевода

TITLE (LANG)

'Echobot IFRAME'

Заголовок для кнопки или команды на указанном языке

DESCRIPTION (LANG)

'Open Echobot IFRAME app'

Описание команды на указанном языке

COPYRIGHT (LANG)

'Bitrix24'

Авторские права

Обратите внимание:

  1. Хоть вы при регистрации IFRAME-приложения и задаете размеры окна, оно может быть уменьшено приложением по фактически доступным размерам. Идеальный вариант — делать таким образом, чтобы оно вписывалось в минимальные размеры и могло свободно адаптироваться к увеличению и уменьшению, это будет очень важно для мобильных устройств
  2. Ссылка на IFRAME обязательно должна вести на сайт с активным HTTPS-сертификатом. Правила разработки IFRAME-обработчика и ограничения вы можете прочитать в документации
  3. Обязательно используйте проверки хешей перед выполнением любых операций.
  4. Приложения доступны только после перезагрузки страницы или после служебного хита на сервер (на разных установках по разному, от 15 до 26 минут). Приложение появится мгновенно только при взаимодействии с контекстной кнопкой
  5. В значения IFRAME_WIDTH и IFRAME_HEIGHT вы указываете желаемые значения ширины и высоты окна приложения. Окно приложения будет уменьшено до размера окна мессенджера, если окно мессенджера окажется меньше. Если же, наоборот, больше, то будут использованы желаемые размеры для приложения
  6. В случае вызова приложения из контекста (клавиатура или меню), оно будет вызвано в контекстном режиме. В этом режиме значение IFRAME_POPUP будет игнорироваться

Пример кода

Примечание

В примере используется функция restCommand. Это метод отправки данных в Битрикс24. Другой пример использования метода вы найдете в примере ЭхоБота. Вы можете использовать для вызова метода свою функцию, javascript-метод BX24.callMethod или bitrix24-php-sdk.

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

$result = restCommand(
    'imbot.app.register',
    Array(
        'BOT_ID' => 62,
        'CODE' => 'echo',
        'IFRAME' => 'https://marta.bitrix24.tech/iframe/echo.php',
        'IFRAME_WIDTH' => '350',
        'IFRAME_HEIGHT' => '150',
        'HASH' => 'd1ab17949a572b0979d8db0d5b349cd2',
        'ICON_FILE' => '/* base64 image */',
        'CONTEXT' => 'BOT',
        'HIDDEN' => 'N',
        'EXTRANET_SUPPORT' => 'N',
        'LIVECHAT_SUPPORT' => 'N',
        'IFRAME_POPUP' => 'N',
        'LANG' => Array(
            Array(
                'LANGUAGE_ID' => 'en',
                'TITLE' => 'Echobot IFRAME',
                'DESCRIPTION' => 'Open Echobot IFRAME app',
                'COPYRIGHT' => 'Bitrix24'
            ),
        )
    ),
    $_REQUEST["auth"]
);

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

Числовой идентификатор созданного приложения APP_ID.

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

Код

Описание

BOT_ID_ERROR

Чат-бот не найден

APP_ID_ERROR

Приложение для чата не принадлежит этому rest-приложению. Работать можно только с приложениями для чата, установленными в рамках текущего rest-приложения

IFRAME_HTTPS

Ссылка на IFRAME обязательно должна быть на сайт с активным HTTPS-сертификатом

HASH_ERROR

Вы не указали хеш для приложения. Мы рекомендуем использовать уникальных хеш для каждого IFRAME и каждой установки

PARAMS_ERROR

Ошибка при указании JS-команды или IFRAME-параметров

LANG_ERROR

Не переданы языковые фразы для видимой команды

WRONG_REQUEST

Что-то пошло не так

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
О создании приложения
Следующая
Изменить данные о приложении в чате