Пример состоит из SDK CRest и кода обработки входящих событий, которые вы должны разместить на своем веб-сервере до добавления приложения в свой Битрикс24. Приложение создает чат-бота внутри вашего Битрикс24, который умеет отвечать пользователям.

Скачать архив:

Чат-бот для мессенджера Битрикс24 не является отдельным "типом" приложений. Фактически, чат-бот может быть частью любого серверного приложения, которое просто будет реализовывать логику чат-бота (или даже нескольких сразу), используя соответствующие возможности REST API. При этом, REST для чат-бота в некоторых случаях позволяет обойтись без разработки полной схемы авторизации по протоколу OAuth 2.0, как того требует общий случай серверных приложений без пользовательского интерфейса внутри Битрикс24.

Установить локальное приложение можно либо из раздела Разработчикам Начиная с версии модуля REST 20.5.0, доступен новый раздел Разработчикам (Приложения > Разработчикам), в котором собраны удобные инструменты для облегчения работы по интеграции и доработке вашего Битрикс24.

Подробнее... (Приложения > Разработчикам, вкладка «Готовые сценарии» > Другое > Локальное приложение), либо перейдя по цепочке: Приложения 1 – Разработчикам 2 – Другое 3 – Локальное приложение 4:

В открывшейся форме заполните базовые поля и укажите необходимые для приложения права (для нашего примера требуются права на создание и управление чат-ботами), указав Путь вашего обработчика (это означает, что ваше приложение уже должно быть физически доступно по URL по протоколу HTTPS до того, как вы станете добавлять его в ваш Битрикс24):

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

В этом случае, как вы увидите, в форме будут скрыты поля, в которых обычно указывается название пункта меню для вызова приложения из Битрикс24. Приложения, у которых включена опция "Приложение использует только API", либо предоставляют пользовательский интерфейс по какому-то своему URL, либо вообще не предоставляют пользовательский интерфейс.

Обратите также внимание на то, что мы заполнили поле Путь для первоначальной установки. Этот URL вызывается только один раз при сохранении формы локального приложения. Именно этот URL служит обработчиком события ONAPPINSTALL, в котором мы и добавляем чат-бота в наш Битрикс24. Если вы захотите добавить чат-бота заново, вам нужно будет из списка приложений переустановить приложение или удалить и заново добавить локальное приложение.
Если вы переустанавливаете приложение из списка приложений: будет вызвано событие ONAPPINSTALL и в файле install.php выполнится код получения из списка ботов бота с кодом, который указывался при создании бота.
Если вы удалите приложение: все боты, созданные этим приложением, автоматически удаляются, соответственно, при создании приложения зарегистрируется новый бот.

После сохранения приложения с чат-ботом вы можете через поиск найти бота по имени "Bot Example":

После сохранения новое приложение будет показано в списке интеграций (Приложения > Разработчикам > Интеграции) в вашем Битрикс24.

Можно написать сообщение чат-боту, кликнув по его названию в общем чате. Это действие откроет индивидуальный чат с чат-ботом. В нашем примере чат-бот просто будет повторять любой текст, который отправит ему пользователь: