Кабинет администратора ботов

Скрипты, рассылки, триггеры, каналы, интеграции, cтатусы, маршруты, лиды, статистика, атрибуты, cсылки

• Бизнесы
• Настройки бота
• Экспорт бота
• Импорт бота
• Лиды
• Скрипты
• Разделы скриптов
• Редактор скрипта
• Создание Меню
• Дерево скриптов
• Маршруты
• Каналы
• Атрибуты
• Триггеры
• Рассылки
• Статусы
• Интеграции
• Статистика
• Кастомные отчеты
• Ссылки
• Deep Linking

Бизнесы

На одном сервере Metabot одновременно могут работать несколько компаний или организаций. Для каждого заказчика или нового пользователя создается свой Бизнес — автоматически при регистрации.

Бизнес — это изолированное пространство, в котором ведется разработка всех ботов заказчика. Ботов может быть сколько угодно.

В бизнес добавляются пользователи, которые получают доступ сразу ко всем ботами. Контроль прав доступа к разным ботам пока минимальный. На данный момент ограничить можно только роли самих пользователей на самом верхнем уровне администрирования платформы, но не внутри отдельного бизнеса.

Существуют следующие роли: 

• editor — имеет доступ к редактированию; 
• viewer — имеет доступ только к просмотру; 
• only_tickets_editor — имеет доступ к просмотру команд и только к функционалу создания/просмотру заявок;
• operator — имеет доступ к контакт-центру;
• bots_merger — имеет доступ к дополнительным функциям при экспорте и импорте.

На бизнес, как и отдельно на ботов, можно наложить ограничения по количеству обслуживаемых пользователей (на платформе эта роль называется лиды), выбрав один из автоматических тарифов или самостоятельно прописав количество человек. Также можно увидеть дату создания и последнего изменения. А в дополнение можно самостоятельно проставить даты начала статистики и дату оплаты.  

Некоторые структурные возможности такие, как тикет-система в разделе Заявок и Интернет-Магазин в одноименном разделе на данный момент настраиваются только на уровне бизнеса.

Главная страница бизнеса

На главной странице бизнеса отображаются все боты бизнеса:

Для каждого бота на главной странице указаны следующие параметры:

• В столбце Бот:
  • Наименование-ссылка бота — имя бота;
  • ID — уникальный числовой идентификатор бота;
  • Код — дополнительный уникальный идентификатор. Используется для отображения в URL, а также для слияния ботов (при импорте) и для поиска бота, например в JavaScript функциях;
  • Дата создания — дата создания бота;
  • Лиды — количество лидов бота;
  • Активных в течени и месяца — количество лидов активных в течении месяца в боте;
• Описание — описание бота;
• В столбце Параметры:
  • Язык бота — языком интерфейса в боте;
  • NLP в приветствии — обнаружение намерения для новых лидов, до запуска скрипта из маршрута;
  • NLP Action в приветствии — обнаружение NLP Action при обнаружении NLP намерения;
  • Оставаться у оператора — не активировать бота, когда лид возобновляет диалог, ранее переадресованный оператору и закрытый им;
  • Попыток подтверждения заявки —  после превышения данного количество попыток работник (персона) будет перемещен в конец очереди, а счетчик отказов по работнику будет сброшен;
  • Роль персоны по умолчанию — для ботов с большими и часто повторяющимися скриптами;
  • Упрощенный лог — для ботов с большими и часто повторяющимися скриптами. Влияет на логирование JS скрипта, вызов которого происходит в системной функции executeV8.
  • Режим отладки — отправка ошибки в мессенджер при общении с лидом.
  • Каналы — все каналы подключенные к боту.

Для каждого бота также доступны следующие операции:

• Редактировать — открывает окно настроек бота для редактирования;
• Удалить — удаляет бот. В целях безопасности перед удалением следует ввести четырехзначный код для подтверждения;
• Скрипты — быстрый переход к меню скриптов бота;
• Лиды — быстрый переход к меню лидов бота;
• Каналы — быстрый переход к меню каналов бота;
• Экспорт бота — экспорт бота в JSON.

Выбрать бота на главной странице бизнеса можно и из выпадающего списка в верхней части страницы.

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

На главной странице доступны следующие функции:

• Экспорт бизнеса/ботов — экспорт бизнеса или ботов в JSON;
• Импорт бизнеса/ботов — импорт бизнеса или ботов из JSON;
• Создать бота — создание нового бота в бизнесе.

Настройки бота

При создании нового бота или при нажатии на кнопку Редактировать уже существующего бота открывается окно свойств бота. Оно содержит следующие поля:

• Название — имя бота;
  
• Код — дополнительный уникальный идентификатор. Используется для отображения в URL, а также для слияния ботов (при импорте) и для поиска бота, например в JavaScript функциях;
• Описание — описание бота;
• Язык бота — выпадающий список с языком интерфейса в боте;
• Включить обнаружение NLP в приветствии — обнаружение намерения для новых лидов, до запуска скрипта из маршрута. Если намерение будет обнаружено, то будет запущен скрипт сообветствующий этому намерению, при этом скрипт из роутера будет проигнорирован;
• Включить обнаружение NLP Action в приветствии — обнаружение NLP Action при обнаружении NLP намерения. Опция действует только если включено обнаружение намерения NLP;
• Оставаться у оператора при возобновлении — не активировать бота, когда лид возобновляет диалог, ранее переадресованный оператору и закрытый им;
• Количество попыток для подтверждения заявки — после превышения данного количество попыток работник (персона) будет перемещен в конец очереди, а счетчик отказов по работнику будет сброшен;
• Роль персоны по умолчанию — для ботов с большими и часто повторяющимися скриптами;
• Упрощенный лог — для ботов с большими и часто повторяющимися скриптами. Влияет на логирование JS скрипта, вызов которого происходит в системной функции executeV8. Эту функцию используют скрипты V8, проверка условий команд, проверка условий Маршрутов, проверка условий, триггеров, выполнение Тела API эндпоинтов, проверка условия рассылки по лиду и т.д.;
• Режим отладки — отправлять ошибки в мессенджер при общении с лидом.

Экспорт бота

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

Кнопки экспорта находятся на главной странице бизнеса. Существует два варианта экспорта:

1. Экспорт всех ботов по кнопке Экспорт бизнеса/ботов.
2. Экспорт отдельного бота по кнопке Экспорт бота напротив него. Отличается он лишь тем, что в окне настроек экспорта в пункте Боты по умолчанию будет выбран только указанный бот.

При переходе по кнопкам открывается окно настроек экспорта со следующими полями:

• Скачать в виде файла — при активации сохраняет JSON с данными ботов в виде файла;
• Сгенерировать ссылку для дальнейшего использования — генерирует ссылку на JSON с данными ботов с указанными в окне параметрами;
  
• Сортировка экспортируемых данных — выпадающий список с двумя вариантами сортировки:
  • По идентификатору — скрипты будут сохранены в порядке их создания;
  • Как в интерфейсе — скрипты будут сохранены в том порядке, в котором расположены в боте;
• Боты — выбор экспортируемых ботов. При нажатии на кнопку Включить / исключить все выбираются или исключаются все боты бизнеса;

• Данные по ботам — выбор экспортируемых данных бота:
  • Код бота (идентификатор) — дополнительный уникальный идентификатор. Используется для отображения в URL, а также для слияния ботов (при импорте) и для поиска бота, например в JavaScript функциях;
  • Настройки бота — все данные из окна настроек бота;

Обязательно отмечаем пункт Настройки бота, иначе в экспортируемые данные не будет включен код бота и всегда будет создаваться новый бот при импорте.

• • Интеграции — данные интеграций бота;
  • Статусы лидов — все статусы лидов бота;
  • Маршруты — все данные маршрутов бота;
  • Скрипты, команды и меню — все данные скриптов бота;
  • Ссылки — все данные ссылок бота;
  • Триггеры — все данные триггеров бота;
  • Рассылки — все данные рассылок бота;
  • Внутреннее API (Конечные точки) — все данные внутреннего API бота;
  • Внешнее API (Конечные точки) — все данные внешнего API бота;
  • Системные атрибуты бота — все системные атрибуты бота;
• Данные по бизнесу — выбор экспортируемых данных бизнеса:
  • Роли персон — все данные ролей персон бизнеса;
  • Виды заявок (структура) — структура всех видов заявок бизнеса;
  • Статусы заявок (структура) — структура всех статусов заявок бизнеса;
  • Произвольные поля заявок (структура) — структура всех произвольных полей заявок бизнеса;
  • Привязки произвольных полей заявок к видам заявок (структура) — структура всех привязок произвольных полей заявок к видам заявок бизнеса;
• Плагины бизнеса — выбор экспортируемых плагинов бизнеса;

• Кастомные таблицы — выбор экспортируемых таблиц бизнеса:
  • Структура — экспорт структуры таблицы;
  • Данные — экспорт данных таблицы.

Учитывайте при экспорте, что одни данные бота или бизнеса могут зависеть от других. Так, например, вы не сможете экспортировать рассылки без скриптов, так как они напрямую связаны и не сможете экспортировать персоны без их ролей, так как персону невозможно создать без роли. В связи с этим, при включении некоторых данных бизнеса на экспорт автоматически включаются другие связанные с ними.

После нажатия на кнопку Экспорт все указанные данные предоставляются в JSON формате.

Если у пользователя бота есть роль bots_merger, ему будут доступны следующие дополнительные поля:

• В Данные по бизнесу: 
  • Персоны — персоны бизнеса;
  • Заявки (данные) — данные заявок бизнеса.

При переносе заявок, необходимо переносить все боты к которым принадлежат заявки.

Импорт бота

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

Кнопка Импорт бизнеса/ботов находится на главной странице бизнеса.

При переходе по кнопке открывается окно настроек импорта со следующими полями:

• Алгоритм импорта — Только добавление новых данных:
  • Только создание новых ботов без слияния;
  • Если данные уже существуют, то будет выведена ошибка, импорт будет отменен;

Подходит для импорта нового бота, импорта данных в новый бизнес или импорта "порции" новых данных в бизнес. Режим гарантирует, что имеющиеся данные не будут затронуты, т.к. обновление в данном режиме не выполняется.

• JSON файл — возможность добавления JSON файла для импорта данных;

Максимальный размер импортируемого JSON файла = 20 Мб.

• JSON — окно добавления JSON кода для импорта данных. Если указан JSON-файл, то текстовое содержимое JSON из поля будет проигнорировано.

В верхней части окна указано предупреждение о выполняемых действиях: в какой бизнес происходит импорт и куда будут добавлены данные по ботам.

После нажатия на кнопку Импорт, если не было обнаружено конфликтов, то данные будут обновлен ы в указанном бизнесе.

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

Если у пользователя бота есть роль bots_merger, ему будут доступны следующие дополнительные поля:

• Алгоритм импорта — выпадающий список с типом импорта:
  • Только добавление новых данных (с поддержкой добавления в уже существующие боты):
    
    • Режим идентичен режиму Только добавление новых данных, за исключением пункта ниже;
    • Осуществляется поиск ботов по полю "код" для добавления в них данных. Если бот не найден, то будет создан новый;
      

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

• • Только обновление существующих данных:
    
    • Только обновление имеющихся данных по ботам и бизнесу, создание новых ботов, данных по ботам и бизнесу не будет выполняться;
      
    • Поиск ботов для обновления их параметров и связанных с ботом данных выполняется по полю "код", если бот не найден, будет выведена ошибка, импорт будет отменен;
      
    • Если данные уже существуют, то они будут обновлены (поиск выполняется по коду, наименованию и т.д.);
      

Подходит для обновления параметров сущностей (например, когда структура бота не меняется, а меняются только текст сообщений или, например, изменены данные кастомных таблиц, в данном случае будут только обновлены имеющиеся записи в таблицах, новые таблицы также не будут созданы).

• • Добавление новых и обновление существующих данных:
    
    • Будет выполнено создание новых и обновление существующих данных по бизнесу и ботам;
      
    • Новые боты будут созданы, если они не будут найдены по полю "код";
      
    • Если боты будут найдены по полю "код", то будут обновлены их параметры и связанные с ботом данные;
      
    • Если данные по ботам и бизнесу уже существуют, то они будут обновлены (поиск выполняется по коду, наименованию и т.д.);

Подходит для слияния данных (например, для переноса новой версии бота или данных по бизнесу);

Будьте аккуратны при импорте в уже работающий бизнес, предварительно экспортируйте данные по бизнесу, чтобы можно было восстановить предыдущую версию.

Ниже приведена таблица слияния — по каким полям выполняется поиск сущностей в БД для того, чтобы определить есть сущность и нужно ли ее обновлять или добавлять.

Сущность	Поле
Данные по ботам
Настройки бота	Код
Интеграции	Наименование
Статусы лидов	Наименование
Маршруты	Код
Ссылки	Наименование
Рассылки	Код
Внутреннее API (Конечные точки)	Алиас
Внешнее API (Конечные точки)	Код
Системные атрибуты бота	По типу и наименованию
Скрипты, команды и меню
Разделы скриптов	Наименование
Скрипты	Код
Команды скрипта	Алиас (в рамках импортируемого бота и скрипта)
Пункты меню	Алиас (в рамках импортируемого бота и скрипта)
Триггеры
Триггеры	Код
События на которые подписан триггер	По виду события
Привязка триггера к ссылке	По наименованию ссылки
Данные по бизнесу
Роли персон	Имя
Персоны	guid
Заявки	guid
Виды заявок	Наименование
Статусы заявок	Наименование
Произвольные поля заявок	Наименование
Привязки произвольных полей заявок к видам заявок	По виду заявки и наименованию поля
Плагины бизнеса
Плагины	Наименование
Скрипты плагина	Наименование
Кастомные таблицы
Параметры таблицы	Наименование
Поля таблицы	Наименование
Данные	ID каждой записи

Лиды

Меню лидов — это список конечных клиентов или пользователей взаимодействовавших с ботом.

Все пользователи, которые когда либо взаимодействовали с вашим ботом, аккумулируются на вкладке Лиды в вашем боте. Когда пользователь связывается с компанией через аккаунт в мессенджере, социальной сети или через окно чата на сайте, создаётся лид.

В раздел Лиды можно перейти по одноименной кнопке на главном экране или из панели управления раздела Настройки бота выбрать пункт меню Лиды.

В лиде на платформе сохраняются все параметры, которые он может приобрести во время общения с ботом. Один из примеров —  теги и атрибуты пользователя — те данные, которые бот создает в ходе диалога. Также по каждому лиду платформы хранится вся история диалога, со всеми временными обозначениями. Диалог осуществляется с помощью обмена вебхуков, историю (лог) которых также можно просмотреть через лида, в целях проверки работы видимых или невидимых для пользователя команд бота.

В соответствующем разделе на платформе размещается список пользователей — лидов, которые взаимодействовали с ботом. По лиду производится сбор следующей информации:

• ID — уникальный идентификатор пользователя на платформе;
• Клиент — имя пользователя в канале связи;
• Внешний ID — уникальный идентификатор пользователя, полученный из канала;
• Канал — канал интеграции;
• Мессенджер — при создании лида заполняется данными мессенджера по каналу интеграции;
• Менеджер — закрепленный за пользователем менеджер;
• Статус — действующий статус лида на данный момент времени;
• Атрибуты — список атрибутов, сохраненных в базе, например: значения, тэги, контекст;
• Операции:
• Отключение / включение реакции бота на сообщения лида;
• Сообщения — список всех сообщений данного пользователя с ботом;
• Уровень отладки — форма редактирования доступа к режиму отладки бота;
• Редактировать — форма редактирования реквизитов по выбранной строке списка лидов;
• Сбросить беседу для этого лида.

Фильтрация и поиск

Фильтрация и поиск данных может производиться по следующим параметрам:

После установки параметров фильтрации нажать кнопку Применить фильтр.

Если необходимо сбросить все установленные фильтры, то нажать кнопку Сбросить фильтр.

Если необходимо сбросить один какой-либо параметр фильтрации, оставив остальные, то надо нажать крестик на данном параметре и кнопку Применить фильтр.

Под наименование раздела Лиды указано количество лидов общее или по примененному в текущий момент фильтру.

Сортировка данных

В разделе Лиды можно сортировать данные по следующим параметрам:

• По возрастанию сортировка по дате создания диалога — вначале таблицы отображаются данные с последнего созданного диалога;
• По убыванию сортировка по дате создания диалога — вначале таблицы отображаются данные с первого созданного диалога;
• По возрастанию сортировка по дате последней активности лида — вначале таблицы отображаются данные с последнего диалога по дате активности;
• По убыванию сортировка по дате последней активности — вначале таблицы отображаются данные с первого диалога по дате активности.

Необходимо в поле Сортировка выбрать нужный параметр и нажать кнопку Применить фильтр

Сортировка может применяться совместно к данным по примененным параметрам фильтрации. По умолчанию установлена обратная сортировка по дате создания диалогов.

Функциональные возможности

Экспорт / Импорт лидов

Над списком лидов возможно выполнение следующих функций:

• Экспорт — при нажатии на ссылку формируется файл формата .csv;
• Экспорт в JSON — при нажатии на ссылку экспортируется список лидов в формете JSON;
• Импорт из JSON — при нажатии на ссылку импортируется список лидов из формата JSON;
• Сбросить все беседы — при нажатии на ссылку происходит сброс бесед по всем лидам, взаимодействовавших с ботом.

При нажатии на Экспорт (в CSV) на странице лидов открывается форма с параметрами экспорта:

В URL формы прописаны все те же параметры фильтров, что были на странице лидов. Если необходимо сменить фильтры, то возвращаемся на страницу лидов, меняем фильтр и нажимаем Экспорт.

Порядок работы с формой:

1. Выбираем Все атрибуты или Указанные атрибуты.
2. Если выбрали Указанные, то задаем список атрибутов через запятую.
3. Выбираем Все записи или Разбивка по страницам.
4. Если выбрали Разбивка, то указываем размер страницы.
5. Нажимаем Сгенерировать ссылки.
6. Скачиваем все csv по сгенерированным ссылкам.

После смены параметров формы не забудьте повторно нажать на кнопку Сгенерировать ссылки, иначе на форме останутся старые ссылки!

Работа с сообщениями

Для просмотра списка сообщений, которые были записаны при взаимодействии лида с ботом, необходимо нажать кнопку Сообщения. На значке показано общее количество сообщений с данным лидом.

По умолчанию открывается список сообщений лида за последнюю неделю. На экранной форме также отображены все параметры по данной записи доступные для просмотра.

Для того чтобы открыть весь список сообщений, необходимо сбросить период отбора и нажать кнопку Применить фильтр.

Для канала Telegram, VK и Umnico имеется возможность напрямую отправить с платформы сообщение лиду.

Для этого необходимо нажать кнопку Отправить сообщение.

Далее в открывшейся форме набрать текст, также можно добавить эмодзи и нажать кнопку Отправить сообщение.

Блокировка работы бота

По одному любому выбранному лиду бот можно остановить, нажав на кнопку Отключение реакции бота на сообщения лида в блоке Операции.

При активном положении данной кнопки у лида:

• Блокируются рассылки по лиду (лид не попадает в выборку лидов для рассылки, т.е. при планировании или запуске рассылки, по данному лиду не будет даже проверяться V8 условие);
• Если уже имеются какие-либо запланированные задания на выполнение по времени, то они не будут запущены;
• Если лид самостоятельно в канале Telegram остановит работу бота, а далее ее возобновит через интерфейс мессенджера, то работа бота возобновится, а кнопка перейдет в положение Отключено, как показано на рисунке выше.

Отладка бота

У лида можно настроить уровень отладки бота, для это необходимо воспользоваться кнопкой Редактировать уровень отладки бота в блоке Операции.

В диалоговом окне необходимо выбрать настройки уровня:

• Выключено — параметр по умолчанию;
• Только V8 (editor) — уровень editor можно выставлять любым пользователя бота;
• V8 и Exceptions (admin) — уровень admin можно выставлять только администраторам платформы или проверенным разработчикам.

При включенном уровне отладки бота будет выдаваться форматированное сообщение об ошибке V8 в боте.

На русском языке:

На английском языке:

Сброс беседы

Для того, чтоб лид вернулся в первоначальную точку беседы с ботом можно воспользоваться функцией сброса диалога по одному лиду, для это необходимо воспользоваться кнопкой Сбросить беседу для этого лида в блоке Операции.

Если всему боту требуется обновление, то можно воспользоваться командой Сбросить все беседы.

Редактирование карточки лида

В разделе редактирования лида можно самостоятельно проставить теги, присвоить новый атрибут, поменять статус лида, присвоить статус или ответственного менеджера, а также установить язык или настроить интеграцию (если в боте их две и более), для этого необходимо воспользоваться кнопкой Редактировать в блоке Операции.

В карточке лида имеется возможность редактирования активной интеграции.

Для этого в выпадающем списке есть все NLP интеграции, в том числе и не активные. Это сделано для того, что могут установить интеграцию, а затем снять галку активности, в таком случае после сохранения на форме редактирования карточки было бы сброшено значение.

После установки активной интеграции по лиду, она отображается в параметре Активная NLP интеграция.

В параметре nlpLastIntegrationCode отображается код последней NLP интеграции, а в параметре nlpLastIntegrationId — ID последней NLP интеграции.

С лидами так же можно работать с помощью JS методов. Все методы и их описание вы можете посмотреть в Справочнике по функциям JS.

Скрипты

Скрипты — это элементы сценария взаимодействия бота с пользователем.

Первый и самый важный шаг в дизайне ботов — это создание диалоговых скриптов, которые связаны между собой. Можно переходить от одного разговора к другому, создавая автоматизированный поток.

Скрипты беседы можно создавать в разделе главного меню Настройки бота подраздел, здесь мы будем описывать сценарии взаимодействия бота с пользователем, а также проектировать меню бота.

На экранной форме нажать кнопку Создать скрипт.

При создании  нового скрипта необходимо заполнить следующие параметры:

• Название — логически понятное название скрипта, например, "Главное меню". Должно быть уникальным;
• Раздел — если скрипт должен быть размещен в разделе, то указать раздел, например, "Скрипты меню", иначе оставить не заполненным;

Рекомендуем также ознакомиться со страницей Разделы скриптов.

• Тип — может принимать значение: Стандарт или Fallback: 
  • Значение Стандарт — скрипт, выполняющий различные функции, используемые, например,  для разговорных сценариев. Устанавливается по умолчанию.
  • Значение Fallback — скрипт, позволяющий описать функции повтора выполняемых действий или текстовых сценариев, если бот не определил намерений пользователя. Например, сообщение — "Извините, не понял Ваш вопрос/ответ. Повторите еще раз". 

Скрипт, имеющий тип Fallback используется с командами: Отправить текст и Повторить вопрос.

Скрипт, имеющий тип Fallback в чат-боте применяется один раз!

• Включить  NLP — активность параметра позволяет настроить и использовать функцию NLP.

Включить обнаружение намерения для новых лидов, до запуска скрипта из маршрута. Если намерение будет обнаружено, то будет запущен скрипт соответствующий этому намерению.

• Использовать определение NLP Action — параметр позволяет настроить функцию NLP — Живой разговор, а также позволяет распознавать все существующие намерения в базе.

Включить обнаружение NLP Action при обнаружении NLP намерения позволяет в запущенном скрипте начать поиск нового намерения. Опция действует только если включено обнаружение намерения NLP. 

• Нажать кнопку Создать.

При наведении на иконку справки показывается более точная информация. 

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

В разделе Скрипты располагается список скриптов данного бота с доступными операциями:

• Перейти в редактор скрипта;
• Редактировать свойства скрипта;
• Удалить скрипт;
• Список скриптов.

Со скриптами так же можно работать с помощью JS методов. Все методы и их описание вы можете посмотреть в Справочнике по функциям JS.

Разделы скриптов

Разделы скриптов предназначены  для группировки скриптов по смысловой принадлежности.

Этой функцией можно воспользоваться для удобства визуализации списка скриптов на экране.

Для этого на экранной форме нужно нажать кнопку Создать раздел.

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

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

Для разделов скриптов доступны следующие операции:

• Развернуть / свернуть — разворачивается список скриптов, входящих в данный раздел;
• Редактировать свойства раздела — позволяет редактировать название раздела;
• Удалить раздел — удаляет запись раздела скриптов из списка.

Для переноса существующего скрипта в какой либо из разделов необходимо:

1. Зайти в свойства скрипта. 

   

2. Поменять раздел. 

   

3. Сохранить.

Редактор скрипта

Редактор скрипта — это форма для наполнения скрипта различными командами и пунктами меню.

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

Наполняя скрипт командами, вы создаете разговорный сценарий, а именно:

• Создаете сообщения в виде текста, эмодзи, изображения, видео или комбинации изображения и текста в виде списка;
• Используете быстрые ответы, которые сделают ваши разговоры интерактивными и помогут вовлечь пользователей;
• Сохраняете контактные данные пользователей в виде атрибутов;
• Создаете сценарии с ветвлением, которые помогают запускать разные потоки на основе ответов пользователей.

А так же используя платформу вы сможете:

• Интегрировать вашу CRM-систему с платформой Metabot24, чтобы загружать данные, собранные на боте, прямо в вашу CRM-систему;
• Отправлять электронные письма с платформы;
• Реализовывать в сценарии бота другие полезные возможности платформы.

После того, как все ваши скрипты беседы будут созданы, вы можете добавить некоторые часто задаваемые вопросы в обучение бота с помощью функции NLP.

Экранная форма редактора скрипта состоит из двух блоков:

• Команды;
• Меню.

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

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

Параметры скрипта можно менять не выходя из него вверху страницы.

Создание Меню

Меню скрипта — способ взаимодействия пользователя с ботом в виде настроенных пунктов меню.

В начале настройки бота необходимо создать главное меню бота. Для создания Меню необходимо перейти в раздел главного меню Настройки бота подраздел Скрипты.

Для этого необходимо:

1. На экранной форме нажать кнопку Создать новый скрипт.
2. Указать название скрипта — "Меню", нажать кнопку Создать, оставив остальные параметры без изменения.
3. Перейти в редактирование скрипта по одноименной операции в правой части строки.

   

4. Создание пунктов меню производится в блоке Меню. Нажать кнопку Добавить пункт меню.

   

5. При создании  нового пункта меню необходимо заполнить следующие параметры:

• Код, ожидаемый в ответе пользователя — это текст, который должен прислать пользователь, чтобы попасть в нужный раздел меню;
• Скрыть код — активность чекбокса позволит скрыть код пункта меню для отображения пользователю.
• Подпись пункта меню — текстовое наименование пункта меню;
• Скрыть весь пункт меню — активность чекбокса позволит полностью скрыть пункт меню для отображения пользователю;
• Перейти в скрипт, после получения кода — параметр, который позволит создать скрипт идентичный наименованию пункта меню или прикрепить уже существующий скрипт. 

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

    6. Нажать кнопку Создать. 

Например, меню будет содержать 4 пункта:

• О нас;
• Каталог;
• Контакты;
• Заказ.

Так оно будет выглядеть в скрипте Меню:

Далее по операции Перейти в редактор скрипта необходимо настроить сценарий для каждого пункта меню. Например, пункт "О нас" может содержать сценарий из текстовых сообщений и картинок, а также тэга "Смотрел_о_нас".

Пункты меню могут также содержать подменю и настраиваются аналогичным способом.

Скрипт Меню должен быть добавлен в первоначальный скрипт разговора с командой Выполнить скрипт.

Дерево скриптов

Дерево скриптов — это удобная визуализация списка скриптов.

Для упрощения навигации в скриптах бота на платформе реализована удобная визуализация списка скриптов в виде дерева. Для ее использования, необходимо в списке скриптов перейди по гиперссылке Отобразить скрипты в виде дерева скриптов.

При таком отображении списка скриптов очень удобно производить проверку входимости скриптов, меню. Для перехода в нужный скрипт достаточно нажать на интерактивную кнопку перед названием скрипта.

Маршруты

От маршрутов зависит по какой из цепочки сценариев пойдет бот при общении с пользователем.

Маршруты — это начальная точка взаимодействия бота и пользователя при получении очередного сообщения пользователя ботом. Маршруты позволяют настроить условия запуска созданных скриптов. ​

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

Если не найден ни один маршрут, то выполняется резервный скрипт с типом Fallback.

Маршруты необходимо создавать в разделе главного меню Настройки бота подраздел Маршруты.

На экранной форме следует нажать кнопку Создать маршрут.

При создании  нового маршрута необходимо заполнить следующие параметры:

• Название — логически понятное название маршрута , например, "Основной маршрут";
• Скрипт — из списка скриптов выбрать скрипт, который будет запущен при старте данного маршрута;
• Регулярное выражение — параметр маршрута, слова по которым бот должен будет запуститься. Например: 
  •  .* — это выражение означает, что старт бота произойдет при любом введенном слове или символе со стороны пользователя;
  • бот|меню — синтаксис написания выражения. Данное выражение позволит настроить запуск бота после остановки или при намерении пользователя вернуться в главное Меню.

Как составить свое произвольное регулярное выражение можно узнать на странице Регулярные выражения.

• Статус лида — значение выбирается из списка , означает при каком статусе лида будет выполняться данный маршрут;
• Контекст лида — параметр маршрута, который задается командой  в скрипте бота и означает выполнение маршрута удовлетворяющего данному условию.

В регулярном выражении есть возможность указания флагов маршрута в формате:

рег_выражение:FLAGS[список флагов через запятую]

Регулярное выражение можно не указывать, тогда запись будет выглядеть так :FLAGS[список флагов через запятую]

Например:

.*:FLAGS[EMPTY,NO_RUN]

Доступные флаги:

• EMPTY — позволяет выполнять проверку v8 условия и запустить маршрут, если во входящем вебхуке от пользователя не указан текст, например, если прислали файл, локацию и т.д.

• ANY — любой текст. Идентично регулярному выражению .* При данном флаге регулярное выражение не проверяется.

• NO_RUN — не запускать скрипт маршрута, чтобы не сбрасывать беседу лида. Флаг необходимо использовать с пустым параметром Запускаемый скрипт в маршруте. Этот флаг необходимо указывать, если в условии маршрута выполняется bot.scheduleJob и return true.

Данный функционал используется при работе с геолокацией.

В разделе Маршруты располагается список маршрутов данного бота с доступными операциями:

• Перейти в редактор скрипта — будет произведен переход в скрипт для редактирования, который указан в свойствах маршрута;
• Редактировать свойства маршрута;
• Удалить маршрут.

Маршруты разделены на 2 группы:

• Обычные маршруты;
• Маршруты с диплинками.

Каждая группа маршрутов обладает своей сортировкой. Сортировка влияет на порядок поиска (и запуска) маршрута. Запускается только первый маршрут подходящий под все условия отбора. Если маршрут найден, то очищается беседа и запускается скрипт указанный в маршруте.

Убедитесь, что в стартовом маршруте НЕ проставлена галочка в пункте Действует в диалоге.

Для всех маршрутов с диплинками считается, что у них включена опция Действует в диалоге. Даже если эта опция отключена, при обработке маршрута с диплинком считается, что она включена.

Даже если случайно сбросим эту опция в базе данных, то на логику это не повлияет.

Более подробно как опция на логику: если включена опция Обработка Deep Link, то после сохранения маршрута (редактирование/создание), на бэке будет автоматически установлена опция Действует в диалоге.

Каналы

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

Каналы необходимо создавать в разделе главного меню Настройки бота подраздел Каналы.

На экранной форме нажать кнопку Новая привязка.

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

• Канал — выбрать из имеющихся;
• Далее в зависимости от выбранного канала открывается список параметров для настройки канала.

Подробные рекомендации по настройка каждого канала находятся в соответсвующих разделах данной инструкции. Вы можете воспользоваться следующими интеграционными каналами:

• Telegram;
• I2CRM;
• Viber;
• VK;
• Jivo;
• Webim;
• LiveTex;
• Битрикс24;
• Umnico;
• Metabot Widget.

Атрибуты

Атрибуты — раздел просмотра сохраненных атрибутов для пользователей, взаимодействовавших с ботом.

На экранной форме отображен весь список атрибутов пользователей, которые были назначены во время взаимодействия пользователя с ботом. В списке отображаются следующие поля:

• Лид — лид, которому принадлежит атрибут;
• Тип — тип атрибута:
  • variable — атрибут-переменная;
  • tag — тэг;
  • context — контекст;
  • json — атрибут в формате JSON;
  • system — системная переменная (общая для всех лидов бота);
• Название — наименование атрибута;
• Значение — значение атрибута;
• Создано — дата создания атрибута;
• Обновлено — дата когда значение атрибута изменилось на новое.

Создать атрибут можно, нажав на кнопку Новый атрибут. В открывшемся окне необходимо заполнить следующие поля:

• Системный — при активации делает атрибут системным, то есть доступным всем лидам бота;
• ID лида — лид к которому будет привязан атрибут;
• Тип атрибута — выпадающий список с типами атрибутов;
• Ключ атрибута — наименование атрибута;
• Значение атрибута — содержимое атрибута.

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

Для поиска атрибутов доступны фильтры:

• Лид — лид, к которому привязан атрибут;
• Название — наименование атрибута;
• Системный — показывает только системные атрибуты;
• Тип — тип атрибута;
• Значение — значение атрибута;
• Удален — показывает только удаленные атрибуты;
• Дата создания с — дата создания атрибута;
• Дата изменения с — дата обновления атрибута.

С атрибутами так же можно работать с помощью JS методов. Все методы и их описание вы можете посмотреть в Справочнике по функциям JS

Триггеры

Триггеры — функция позволяющая приводить в систему список некоторых действий или событий.

Триггеры можно создавать в разделе главного меню Настройки бота подраздел Триггеры. 

На экранной форме следует нажать кнопку Новый триггер.

Пример

Создадим триггер без подписки на событие, для этого заполним следующие параметры:

• Наименование триггера — текстовое интуитивно понятное название триггера;
• Код — дополнительный уникальный идентификатор. Используется для поиска текущего объекта, например, в JavaScript функциях;
• Список событий — события на которые может быть подписан триггер с названием объекта, который будет подписан на данный тип события (например полное название тэга, контекста, атрибута и т.д):
  • Любое изменение лида;
  • Изменение Статуса лида;
  • Изменение (добавление или удаление) Тэга лида;
  • Изменение (добавление или удаление) Контекста лида;
  • Изменение Атрибута лида;
  • Любое изменение в Заказе;
• JavaScript условие запуска Скрипта/Триггера — условие при котором происходит активация скрипта;

Есть возможность выбора скрипта который будет срабатывать при соответствию условий или срабатывать при не соответствию условий заданных выше.

Выполняется добавление в очередь на запуск привязанного скрипта. В планировщике в установленное время выполняется запуск указанного скрипта. 

• Добавить тэги — дополнительные теги скрипта;
• Удалить тэги — удалить теги оригинального скрипта;
• Контекст запускаемого скрипта/триггера — от лица кого будет происходить активация скрипта;
• Запускаемый скрипт — какой скрипт будет вызываться триггером;
• Запускаемый триггер — значение выбирается из списка созданных триггеров;

Выполняется добавление в очередь на запуск привязанного триггера. В планировщике в установленное время выполняется запуск указанного Триггера. Если для запуска указан другой триггер, то проверка условия будет выполнена перед запуском второго триггера, т.е. по расписанию планировщика.

Для запуска могут быть указаны как Скрипт, так и Триггер одновременно.

• Запустить указанный Скрипт/Триггер в — указывается дата и время, в которое будет выполнен запуск триггера/скрипта точно в указанное время (с погрешностью в 1 минуту);
• Запустить указанный Скрипт/Триггер через (минут) — числовое значение в минутах, через которое будет выполнен запуск триггера/скрипта, спустя указанное количество минут;

Параметр Запустить указанный Скрипт/Триггер через (минут) игнорируется, если указано точное время запуска, т.е. если указан параметр Запустить указанный Скрипт/Триггер в.

• JavaScript условие запуска Скрипта/Триггера — условие, при выполнении которого произойдет запуск триггера.

Если запуск триггера должен быть выполнен как отложенный по времени (указано время запуска или время, через которое нужно запустить триггер), то проверка JS условия текущего триггера выполняется до запуска триггера, а не в момент наступления указанного времени.

Если поле JS условия пусто, то оно всегда истинно при проверке.

После заполнения параметров следует нажать кнопку Создать.

При редактировании существующего триггера появляется галка включен. Что позволяет деактивировать ненужный в данный момент триггер. 

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

Этапы запуска и установки триггера:

• Наступление события для запуска триггера или отложенный запуск по расписанию;
• Проверка JS условия;
• Запуск связанного Скрипта / Триггера или добавление отложенного запуска в планировщик.

В разделе Триггеры располагается список созданных триггеров для данного бота с доступными операциями:

• Редактировать триггер;
• Сообщения полученные подписчиками в результате выполнения триггера;
• Подписчики получившие сообщение в результате выполнения триггера;
• Удалить триггер.
  

С триггерами так же можно работать с помощью JS методов. Все методы и их описание вы можете посмотреть в Справочнике по функциям JS

Рассылки

Рассылки — функция позволяющая проводить автоматическое уведомление пользователей, взаимодействовавших с ботом.

Раздел Рассылки служит для создания рассылок по заданному условию для списка подписчиков.

Рассылки необходимо создавать в разделе главного меню Настройки бота подраздел Рассылки.

На экранной форме нажать кнопку Новая рассылка.

При создании новой рассылки необходимо заполнить следующие параметры:

• Наименование Рассылки — текстовое название рассылки, например: "Рассылка новому подписчику";
• Запускаемый скрипт конструктора — из выпадающего списка выбрать ранее созданный скрипт, который будет запускаться при старте рассылки;
• JavaScript условие для запуска рассылки — JS условие при выполнении которого произойдет запуск рассылки, например: у пользователя добавился тэг — "подписался_на_обучение".

После заполнения параметров следует нажать кнопку Создать.

Сценарий скрипта рассылки должен быть описан заранее в отдельном скрипте, например как на рисунке ниже.

В данном разделе размещается список рассылок с доступными операциями по ним:

• Запустить рассылку — запуск рассылки будет произведен всем подписчикам по выполненному JS условию. Так как процесс не обратимый, то запуск выполняется при утвердительном ответе на предупреждающее сообщение;
• Редактировать — открывается форма редактирования настроек рассылки;
• Удалить — удалить рассылку из списка;
• Подписчики — список лидов-подписчиков, которым будет произведена рассылка;
• Сообщения — отчет о количествах сообщений по произведенной рассылке с возможностью отбора количества за период времени:
  • Выбрать нужного подписчика или оставить параметр Все.
  • Установить календарный период С... - По..., воспользовавшись календарем.
  • Нажать кнопку Применить фильтр.

После выполненной рассылки в Списке лидов отображается общее количество лидов, на которых была отправлена рассылка.

При переходе по ссылке Лиды открывается список лидов, которым была отправлена рассылка.

С рассылками так же можно работать с помощью JS методов. Все методы и их описание вы можете посмотреть в Справочнике по функциям JS

Статусы

Статусы необходимы для классификации клиентов по этапам их обработки. С помощью статусов бот различает логику взаимодействия с клиентом.

При создании бота необходимо создать минимальный набор статусов:

1. В разделе Настройки бота выбрать пункт меню Статусы;
2. На экранной форме находятся две кнопки:
   • Создать — список статусов, созданный пользователем, при конфигурировании бота;
   • Синхронизировать — данная функция используется при интеграции бота с CRM-системами. В CRM-системах есть свой список статусов, который должен быть синхронизирован в Metabot24.

Синхронизация статусов нужна, чтобы связать между собой статусы в Umnico со статусами в вашем боте на платформе Metabot24. После установки связки напротив каждого статуса появится Внешний ID (т.е. идентификатор статуса в системе Umnico), что означает что связь статусов произошла. Теперь вы сможете менять статус заявок в Umnico из бота, выполняя команду Изменить статус лида в скриптах.

Для корректной работы бота необходимо создать как минимум один статус — Первичное касание:

1. Нажать на кнопку Создать;
2. Указать название статуса, например, Первичное касание;
3. Нажать на форме кнопку Создать.

После настройки интеграции канала, например Uminco или Битрикс24 , необходимо выполнить синхронизацию статусов:

• Нажать кнопку Синхронизация;
• Подтвердить или отменить выполняемую операцию.

Синхронизация завершена успешно, если в списке Статусов появятся записи с заполненным полем Внешний ID, которое является идентификатором статуса в Umnico.

Как только проведена синхронизация платформы Metabot с Umnico, то появляется возможность из Metabot управлять статусами в Umnico.

В процессе работы можно создавать новые статусы, редактировать и удалять. Удаление статуса производится с подтверждающим сообщением данной операции. 

Со статусами так же можно работать с помощью JS методов. Все методы и их описание вы можете посмотреть в Справочнике по функциям JS

Интеграции

Раздел Интеграции служит для привязки созданного бота к сторонним сервисам. 

Интеграции необходимо создавать в разделе главного меню Настройки бота подраздел Интеграции.

Для этого на экранной форме нажмите кнопку Новая привязка.

В диалоговом окне заполните следующие параметры:

• Включена — флаг активности интеграции;
• Интеграционная система:
  • Dialogflow — NLP система;
  • Rasa — NLP система;
  • DaData — сервис адресов;
  • Dialogic — NLP система;
• Название — наименование интеграции в интерфейсе;
• Код — код для обращения к интеграции из JS;
• Авторизационный ключ (JSON) — ключ интеграции (для Dialogflow);
• Хост — хост интеграции (для Rasa и Dialogic);
• Пресет — пресет интеграции (для Dialogic);
• Минимальный порог обнаружения намерения — (для Dialogic);
• Токен — токен интеграции;
• Описание — описание интеграции.

Затем следует нажать кнопку Создать.

В разделе Интеграции с ботом располагается список всех настроенных интеграционных привязок для данного бота с доступными операциями: 

• Редактировать — открывается форма для редактирования выбранной интеграции;
• Удалить — при нажатии производится удаление выбранной привязки.

​

Статистика

Статистика — раздел для контроля за накопленной статистикой за период времени.

В раздел Статистика можно перейти по одноименной кнопке, которую можно найти в выпадающем списке Аналитика в верхнем меню бота, или из панели управления раздела Настройки бота выбрать пункт меню Статистика.

На экранной форме можно увидеть какой на текущий момент у него Тариф, общее количество Активных лидов и сколько лидов разрешено по тарифу.

Для отображения статистики следует указать период времени для которого она будет посчитана. Это можно сделать при помощи фильтров вверху страницы.

В подпункте Лиды и сообщения можно посмотреть статистику отдельно по всем ботам и по бизнесу. В таблице указаны:

• Активных лидов — общее количество активных лидов за выбранный период времени;
• Новых лидов — общее количество новых лидов за выбранных период времени;
• Сообщений — общее количество сообщений лидов за выбранный период времени.

В подпункте Активности можно посмотреть статистику заданий и вебхуков всего бизнеса.  В таблице указаны:

• Количество активностей — количество заданий, вебхуков и вызовов API за выбранный период времени;
• Превышений длительности — количество лимитов длительности активности (задания и вебхуки: 3 секунды / вызовы API: 0,3 секунды) за выбранный период времени;
• Превышений частоты — количество превышений частоты в 10 запросов в минуту.

Кастомные отчеты

Функционал Кастомных отчетов позволяет создавать настраиваемые отчеты со статистикой лидов и активностей.

В меню Кастомных отчетов можно перейти по пункту Отчеты из выпадающего списка Аналитика.

В открывшемся меню доступен выпадающий список в котором можно выбрать один из трех видов отчетов:

• Активности: Превышение лимитов по всем бизнесам — отчет показывающий статистику по превышениям лимитов активностей;
• Лиды — отчет показывающий статистику по лидам;
• Активности: Все бизнесы — отчет показывающий статистику по количеству активностей.

Рассмотрим подробнее каждый из отчетов ниже.

Активности: Превышение лимитов по всем бизнесам

При выборе вида отчета Активности: Превышение лимитов по всем бизнесам, на странице появятся следующие поля и кнопки:

• Период с — фильтр для указания периода времени, для которого будет составлен отчет;
• Экспорт — при нажатии на Все страницы автоматически скачается сформированный отчет в формате excel;
• Компактный вид — позволяет отобразить отчет в более сжатом формате;
• Сформировать отчет — кнопка формирования отчета;
• Сбросить фильтр — кнопка сброса отчета;
• Очистить все поля — кнопка отчищающая все фильтры и поля.

В сформированном отчете отображаются следующие данные:

• ID бизнеса — id бизнеса, для которого рассчитываются превышения;
• Бизнес — наименование бизнеса, для которого рассчитываются превышения;
• Макс. в Мин. — максимальное количество активностей в минуту;
• Превышений — количество превышений активностей;
• Длительность превышений (сек.) — сумма длительности превышений в минуту;
• QNT_PRC10 - 100 — количество превышений каждого вида.

Лиды

При выборе вида отчета Лиды, на странице появятся следующие поля и кнопки:

• Создан с — фильтр для указания периода времени, для которого будет составлен отчет;
• ID лида — id лида по, которому будет составлен отчет;
• Имя лида — имя лида, по которому будет составлен отчет;
• Есть все тэги — все тэги имеющиеся у лидов, по которым будет составлен отчет;
• Есть любой тэг — любой из тэгов имеющийся у лидов, по которым будет составлен отчет;
• Нет любого тэга — любой из тэгов, которого нет у лидов, по которым будет составлен отчет;
• Экспорт — при нажатии на Все страницы автоматически скачается сформированный отчет в формате excel;
• Компактный вид — позволяет отобразить отчет в более сжатом формате;
• Сформировать отчет — кнопка формирования отчета;
• Сбросить фильтр — кнопка сброса отчета;
• Очистить все поля — кнопка отчищающая все фильтры и поля.

В сформированном отчете отображаются следующие данные:

• ID  — id лида;
• Лид  — имя лида;
• Канал  — номер канала, по которому обращался лид;
• Идентификатор  — идентификатор лида;
• Статус  — id статуса лида;
• Бот выкл.  — выключен ли бот (0 — нет/1 — да);
• Переведен на оператора  — переведен ли лид на оператора (0 — нет/1 — да);
• Тэги  — тэги лида;
• Язык  — язык лида;
• Сообщений  — количество сообщений от лида;
• ID последнего сообщения  — id последнего сообщения лида;
• Дата последнего сообщения  — дата последнего сообщения лида;
• Последняя активность  — последняя активность лида в диалоге;
• Создан  — дата создания лида.

Активности: Все бизнесы

При выборе вида отчета Активности: Все бизнесы, на странице появятся следующие поля и кнопки:

• Период с — фильтр для указания периода времени, для которого будет составлен отчет;
• Экспорт — при нажатии на Все страницы автоматически скачается сформированный отчет в формате excel;
• Компактный вид — позволяет отобразить отчет в более сжатом формате;
• Сформировать отчет — кнопка формирования отчета;
• Сбросить фильтр — кнопка сброса отчета;
• Очистить все поля — кнопка отчищающая все фильтры и поля.

В сформированном отчете отображаются следующие данные:

• ID бизнеса — id бизнеса, для которого рассчитываются активности;
• Бизнес — наименование бизнеса, для которого рассчитываются активности;
• Количество активностей — количество активностей за указанный период времени;
  
• Длительность всех активностей (сек.) — сумма длительности всех активностей.

Ссылки

В Metabot есть три вида ссылок: пользовательские ссылки, ссылки для магазина в боте и deep link. С помощью создания пользовательских ссылок вы сможете отслеживать статистику переходов по ним, а при помощи deep link создавать новые точки входа в бота.

О ссылках для магазина вы можете подробнее узнать из раздела Магазин в боте

Ссылки можно создавать в разделе главного меню Настройки бота подраздел Ссылки.

Для создания ссылки следует на экранной форме нажать кнопку Создать.

Откроется окно Создания ссылки со следующими параметрами:

• Имя — наименование ссылки, которое будет использоваться в макропеременной для ее вызова в боте;
• Текст/приглашение — текст, который будет показан вместе с ссылкой;
• Тип ссылки — выпадающий список со следующими вариантами выбора:
  • Пользовательская ссылка — ссылки на внешние источники;
  • Магазин - Главная — ссылка на главную страницу магазина бота;
  • Магазин - Корзина — ссылка на корзину магазина бота;
  • Ссылка на бот-скрипт (Deep Link) — ссылка на скрипт в боте;
• URL — адрес ссылки;
• Создать триггер 'clicked' — создает триггер, считающий количество переходов по ссылке;
• Создать триггер 'ignored' — создает триггер, считающий количество лидов проигнорировавших ссылку.

После нажатия на кнопку Создать ссылка появится в таблице:

Здесь отображается вся информация о ссылке, макропеременная для вызова ссылки (1), привязанные к ней триггеры (2) и информация о них, а так же статистика (3) лидов, взаимодействовавших с ссылкой и общее число переходов.

Про Deep Link подробнее смотрите на странице Deep Linking

Теперь макропеременную ссылки можно добавить в любом месте бота с помощью команды Отправить текст. 

Deep Linking

В контексте чат-ботов для мессенджеров и социальных сетей смысл диплинка заключается в создании унифицированного идентификатора ресурса (URI), который ссылается на определенный диалоговый сценарий в чат-боте, а не в простом запуске чат-бота сначала.

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

В цифровом пространстве deep link можно использовать, например, для размещения на рекламных баннерах в социальных сетях, на веб-сайте для отслеживания переходов с уникальных мест, передача токена авторизации в бот прямо с сайта, можно отправить в личном сообщении и многое другое.

Примеры внешнего связывания с вещами в физическом мире:

• Deep link в виде QR на кассовом чеке, в котором содержится идентификатор транзакции, для приглашения пользователя в программу лояльности в чат-боте и начисления баллов за этот заказ;
• Deep link на брошюре на столике в ресторане с вызовом официанта, содержащий номер столика;
• Рекламные флаеры и буклеты;
• QR в секретном месте в квесте в парке развлечений;
• QR на объектах в музее или в спортзале и т.д.

В каждом случае пользователь при открытии deep link попадет в чат-бот и активирует определенный сценарий, уникальный для этой конкретной ссылки. Через deep link в чат-бот можно передать параметры, например, токен заказа или идентификатор страницы, с которой совершен переход.

Поддержка deep link реализована для каналов:

• Прямая интеграция VK;
• Прямая интеграция Telegram;
• Интеграция через Umnico для WhatsApp;
• Metabot Widget.

Создание deep link

Так как диплинки напрямую взаимосвязаны с каналами, в первую очередь следует настроить каналы, соответствующие вашим требованиям, в боте.

 Что такое каналы и как их настраивать можно узнать в разделе Каналы

Далее можно перейти к созданию диплинков. Это можно сделать в верхнем меню  в разделе Настройки бота подразделе Ссылки.

В меню создания ссылок будут храниться все настроенные вами диплинки и ссылки других типов. Создание новой ссылки производится любой из кнопок Создать.

Перед вами откроется диалоговое окно со следующими полями:

• Имя — имя диплинка, по которому на него можно будет ссылаться ({{ ^#имя_диплинка }} - макроссылка, поддерживаемая в Маршрутах);
• Текст/приглашение — текст который будет добавлен к сообщению пользователя в мессенджере при его переходе по диплинку. Используется только для мессенджера - WhatsApp;
• Тип ссылки — для создания диплинка из выпадающего списка следует выбрать пункт Ссылка на бот-скрипт (Deep Link);
• URL — автозаполняемое поле, url ссылка диплинка.

После нажатия кнопки Создать диплинк появится в меню ссылок:

Последним этапом является добавление маршрута привязанного к диплинку.

Что такое маршруты и как их создавать вы можете узнать в разделе Маршруты

Особенности создания маршрута с диплинком:

• Поле Обработка Deep Link должно быть активно;
• В поле регулярное выражение следует ввести макроссылку диплинка в формате {{ ^#имя_диплинка }}.

Именно этот маршрут будет активирован при переходе пользователя по диплинку.

Использование deep link

Внешние мессенджеры

После создания ссылки автоматически создаётся уникальный хеш диплинка и происходит генерация URL для каждого мессенджера. Перечень мессенджеров определяется из того, к каким Каналам подключен данный бот.

В ссылке для Telegram бота — ( https://app.metabot24.com/deeplink/telegram/{имя-бота-telegram}/... ) {имя-бота-telegram} — следует заменить на соответствующий ID бота в мессенджере.

В ссылке для WhatsApp бота — ( https://app.metabot24.com/deeplink/whatsapp/{телефон-whatsapp}/... ) {телефон-whatsapp} — следует заменить на номер телефона в формате 79ххххххххх соответствующий боту.

После подстановки ссылку с данным URL можно размещать в интернете. При необходимости к ней можно добавить параметры, как это стандартно делается для http-ссылок.

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

Для использования полученных из диплинка параметров можно воспользоваться следующим кодом:

let jsonD = lead.getJsonAttr('sys_last_script_request_params');
let foo = jsonD.deeplink.foo;
let boom = jsonD.deeplink.boom;

lead.setAttr("foo", foo);
lead.setAttr("boom", boom);