В данном руководстве приведен пошаговый пример интеграции исходящего голосового бота с Битрикс24.
Информация актуальна и при интеграции ботов других каналов, в таком случае не потребуется создавать шаблон задания на обзвон в личном кабинете, и при импорте шаблона в приложении потребуется выбрать другую вкладку для импорта нужного канала.
¶ 1. Начало работы
Перед началом работы с битрикс требуется установить приложение twin в битрикс. Подробная инструкция по установке приложения доступна в статье:
Начало работы Битрикс24
¶ 2. Подготовка сценария
- В личном кабинете перейдите в раздел Сценарии ботов.
- Если у вас еще нет сценария, создайте новый сценарий.
¶ (Опционально) Передача переменных из сценария в Битрикс
Если требуется передавать переменные из бота в Битрикс, то эти переменные нужно зафиксировать с помощью действия Произвольный результат в блоке Результат.
В произвольные результаты можно зафиксировать как переменные, так и обычный текст. Переменные обозначаются фигурными скобками.
В поле Название указывается произвольное название, с помощью которого можно будет получить значение в Битриксе. Рекомендуется указывать название на латинице, без специальных символов.
В поле Значение можно зафиксировать как переменные, так и обычный текст. Переменные обозначаются фигурными скобками.
Стоит учитывать, что фиксация произвольного результата происходит только тогда, когда бот достигает блока с этим действием в ходе сценария. Если блок пропущен или не был достигнут, то настроенное в нем действие не будет выполнено.
Пример фиксации произвольного результата:
¶ 3. Создание шаблона задания на обзвон
Если настройка интеграции производится для исходящего голосового бота, то предварительно требуется создать шаблон задания на обзвон.
Для входящих голосовых ботов и текстовых ботов данное действие не требуется.
Если у вас еще не создан шаблон задания на обзвон:
- Перейдите в раздел Голосовые боты → Шаблоны заданий.
- Создайте новый шаблон задания на обзвон с использованием требуемого сценария.
¶ 4. Импорт шаблона в Битрикс24
Ниже приведен пример настроек импорта шаблона – настройки могут различаться в зависимости от задачи, которую должен выполнять бот. Подробная информация об импорте шаблонов доступна в статье Импорт шаблонов в Битрикс24.
- Перейдите на вкладку Исходящая телефония в настройках приложения TWIN для Битрикс24.
- Выберите созданный в личном кабинете шаблон задания на обзвон из выпадающего списка. Откроется панель настроек.
- Выберите базовую сущность: Контакт.
- Убедитесь, что установлен флажок Регистрировать шаблон как SMS-провайдер.
- Нажмите кнопку Импортировать.
¶ 5. Добавление действия при окончании диалога
Ниже приведен пример настроек действия – настройки могут различаться в зависимости от задачи, которую должен выполнять бот. Подробная информация о действиях при окончании диалога доступна в статье Импорт шаблонов в Битрикс24.
Для отправки переменных из бота в Битрикс используются действия при окончании диалога.
- Перейдите в раздел Исходящая телефония → Действия при окончании диалога.
- В поле Шаблон задания выберите нужный шаблон задания на обзвон.
- В поле Тип действия выберите Создать сделку.
- Нажмите кнопку Добавить. Появится окно настройки действия.
- Нажмите кнопку Добавить поле под заголовком Заполнение полей.
- В поле Значение указывается обращение к полю, информация из которого будет передана в карточку.
Обратиться можно как к системным полям бота, так и к собственным полям, зафиксированным с помощью действия Произвольный результат в сценарии бота.
Список системных полей приведен в статье Действия при окончании диалога в Битрикс24.
Обращение к собственным полям происходит в формате {result.название}, где название – название поля произвольного результата.
Стоит учитывать, что обратиться возможно только к системным и произвольным полям результата – обычные переменные не передаются из бота в битрикс.
- В поле Поле нужно выбрать поле карточки, в которое будет записано значение, переданное из бота. Если в выпадающем списке не отображается нужное поле, то следует проверить настройки карточки Битрикс - возможно поле скрыто в карточках, или доступ/запись в поле ограничены.
Полноценная работа гарантируется только для полей с типом Строка – поля иных типов могут не отображаться в списке, либо запись данных может происходить некорректно. Также стоит учитывать, что несколько значений не могут быть записаны в одно и то же поле – если выбрать одно поле для записи нескольких значений, то будет сохранено только одно значение.
На скриншоте приведен пример импортирования системного поля и нескольких полей произвольного результата:
8. Нажмите кнопку Импортировать или Обновить.
При необходимости также можно настроить условия выполнения действия. Если условия не добавлены, то назначенное действие будет выполняться после каждого диалога. Информация о настройке условий выполенения доступна в статье Действия при окончании диалога в Битрикс24.
¶ 6. Старт диалога
Инструкция по запуску диалогов доступна в статье Старт диалога в Битрикс24.