Регистрация приложения для чата

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

Вызов метода для JS-команды

$result = restCommand('imbot.app.register', Array(

   'BOT_ID' => 62, // Идентификатор бота владельца приложения для чата
   'CODE' => 'echo', // Код приложения для чата
   'JS_METHOD' => 'SEND', 
   'JS_PARAM' => '/help', 
   'ICON_FILE' => '/* base64 image */', // Иконка в base64
   'CONTEXT' => 'BOT', // Контекст приложения
   'EXTRANET_SUPPORT' => 'N', // Доступна ли команда пользователям экстранет, по умолчанию N
   'LIVECHAT_SUPPORT' => 'N', // Поддержка онлайн-чата 
   'IFRAME_POPUP' => 'N', // iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно. 
   'LANG' => Array( // Массив переводов, желательно указывать как минимум для RU и EN
      Array('LANGUAGE_ID' => 'en', 'TITLE' => 'Echobot BUTTON', 'DESCRIPTION' => 'Send help command'),

   )

), $_REQUEST["auth"]);

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

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

Формат иконки ICON_FILE:

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

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

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

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

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

$result = restCommand('imbot.app.register', Array(

   'BOT_ID' => 62, // Идентификатор бота владельца приложения для чата
   'CODE' => 'echo', // Код приложения для чата
   'IFRAME' => 'https://marta.bitrix.info/iframe/echo.php', 
   '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
      Array('LANGUAGE_ID' => 'en', 'TITLE' => 'Echobot IFRAME', 'DESCRIPTION' => 'Open Echobot IFRAME app', 'COPYRIGHT' => 'Bitrix24'), 
   )

), $_REQUEST["auth"]);

Результат выполнения

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

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