MAX: Запуск сценариев чат-бота и готовые решения

В VK CXhub вы можете создавать сценарии чат-ботов для МАХ с нуля или использовать готовые решения и адаптировать их под свои задачи.

Для мессенджера МАХ доступна отправка сообщений как в диалог с клиентом, так и в групповой чат.

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

• Для отправки сообщений в групповой чат бот должен быть администратором группы. Для этого сначала добавьте бота в группу участником, нажав «Добавить участников»:

Найдите бота, которого хотите добавить, выберите его и нажмите «Добавить»:

Затем сделайте бота администратором:

Готовые решения

Мы подготовили для вас 6 шаблонов сценариев для мессенджера МАХ с наиболее популярными чат-ботами, в которых для вашего удобства полностью настроены логика и шаги. Вам остается только подключить необходимые интеграции, изменить тексты бота и запустить сценарий.

• В шаблонах готовых решений мы использовали все доступные в VK CXhub действия для чат-ботов МАХ, чтобы вы могли использовать готовые решения также в качестве примера при создании сценария чат-бота МАХ с нуля.

• Внутри каждого шага вы найдете примеры текстов, которые отправляет бот, а также указание того, какой шаг (действие) используется для данного шага.

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

Как запустить сценарий чат-бота в МАХ

1. Зарегистрируйтесь и создайте проект в VK CXhub.

2. Создайте интеграцию с МАХ, следуя инструкции, а также интеграции с другими внешними системами, если они используются в шаблоне. Инструкции по интеграциям с внешними системами вы можете найти в разделе «Интеграции» базы знаний.

3. Перейдите в раздел «Шаблоны» и найдите шаблоны сценариев для МАХ, воспользовавшись поиском или фильтром «Тип интеграции» (МАХ)

4. Выберите необходимый шаблон и нажмите «Использовать шаблон».

5. Вы попадете на страницу «Конструктора сценариев» с копией выбранного шаблона:

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

Важно! Если в полях MAX ID и Chat ID в шаблоне уже проставлены значения, их изменять не нужно. В остальных случаях следуйте подсказкам к полям. Подробнее о MAX ID и Chat ID.

Дополнительно при необходимости вы можете изменить:

• Название шаблона

• Названия шагов в сценарии

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

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

Важно! Для интеграции МАХ для ожидания входящего сообщения клиента необходимо использовать шаги «Ждем → Наступление события → Входящие запросы → МАХ → Входящее сообщение МАХ» и «Ждем → Наступление события → Входящие запросы → МАХ → Нажатие на кнопку в сообщении МАХ».

Если вы выберите шаг «Ждем → Сообщение клиента», бот не увидит это сообщение. В текущей реализации данный шаг работает только для ботов ВКонтакте, Telegram, Whatsapp.

1. Запустите сценарий, нажав кнопку «Запустить версия 1» в правом верхнем углу:

1. Протестируйте сценарий. В случае некорректной работы чат-бота воспользуйтесь инструкциями «Как понять, где ошибка в сценарии» и «Бот не работает, что делать».

Что такое MAX ID, User_id и Chat_id: в чем отличие и как использовать в чат-боте

• MAX ID — уникальная переменная клиента в VK CXhub, которая является значением User_id в мессенджере МАХ. При отправке сообщения по MAX ID (User_id) сообщение приходит в персональный диалог клиента с ботом.

• Chat_id — это идентификатор чата в МАХ. В Chat_id может быть значение как группового чата с множеством участников, так и персонального диалога с клиентом (после того, как клиент первый раз напишет в бот МАХ, для клиента создается идентификатор персонального чата с ботом).

Таким образом, в персональный диалог с клиентом сообщение может отправляться как по User_id (переменная MAX ID в VK CXhub), так и по Chat_id.

При отправке сообщения по Chat_id оно отправляется в чат: если указан идентификатор группового чата, сообщение придет в групповой чат, а если указан идентификатор диалога с клиентом, сообщение придет в личный диалог с клиентом аналогично отправке по User_id.

Использование Chat_id в шагах сценария VK CXhub делает их универсальными для групповых чатов и диалогов.

Список триггеров и действий для чат-ботов МАХ в VK CXhub

Для мессенджера МАХ в VK CXhub реализован набор шагов сценариев (триггеров и действий), которые вы можете использовать для построение схемы вашего чат-бота совместно со стандартными функциональными возможностями платформы.

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

Форматирование сообщений бота

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

В настоящее время поддерживается следующий синтаксис Markdown:

• *курсив* и _это курсив_

• **жирный** и __такой же жирненький__

• ~~зачеркнутый~~

• ++подчеркнутый++

• `code` для встроенного monospaced текста (концы строк внутри этого блока рассматриваются как пробелы)

• ```code``` для monospaced текстового блока

• ^^что-то очень важное^^ для выделенного текста

• [название для ссылки](https://dev.tamtam.chat/) для встроенных URL-адресов

• # заголовок первого уровня

Важно! Для сообщений, отправляемых по Chat_id на данный момент недоступен перенос текста на новую строку. В случае использования переноса сообщение бота в cценарии VK CXhub не будет отправлено, и в сессии клиента будет ошибка:

Дополнительно

Как отправить сообщение бота с нужным количеством кнопок

Если вам необходимо отправить более 3 кнопок в сообщении бота, вам необходимо создать новый исходящий запрос, аналогичный запросам «Отправка сообщений с кнопками в чат». 

1. Перейдите в разде «Интеграции».

2. Найдите вашу интеграцию МАХ и нажмите на нее. Откроется ваша подключенная интеграция:

3. В левой части экрана нажмите «Исходящие запросы» и нажмите кнопку «Создать новый запрос»

4. В новом окне перейдите еще раз на вкладку «Исходящие запросы» и найдите запрос «Сообщение в чат с кнопками (3 кнопки)», откройте его. Данный запрос будет использоваться в качестве примера.

5. На странице нового запроса заполните информацию:

• Название запроса: любое название, удобное вам
• Тип интеграции: МАХ
• Безопасное кодирование параметров: Отключить
• Метод: POST
• URL: https://botapi.max.ru/messages?access_token=#access_token#&chat_id=#chat_id#
• Headers: Authorization / Bearer ваш_токен.
• Body:

тип Raw, тело запроса — тело запроса аналогично запросу, который мы рассматриваем в качестве примера, но в него необходимо добавить дополнительные строки для новых кнопок. В примере ниже жирным шрифтом выделен фрагмент, который добавляется для одной дополнительной кнопки. Фрагмент добавляется столько раз, сколько вам необходимо дополнительных кнопок. Менять в названиях переменных необходимо только цифры, соответствующие номеру кнопки. Для проверки корректности сформированного кода воспользуйтесь сервисом https://jsonlint.com/. 

6. Нажмите кнопку «Сгенерировать настройки параметров» и заполните все поля аналогично запросу, который рассматриваем в качестве примера, включая те, которые открываются в модальном окне при нажатии на символ карандаша.

7. После внесения настроек нажмите кнопку «Сохранить запрос» и протестируйте запрос в блоке «Тестирование запроса».

8. После этого ваш созданный запрос появится в списке доступных запросов при добавлении шага «Действие → Выполнить исходящий запрос → МАХ → Название нового запроса».