Работа с данными шагов
Это значения переменных, которые формируются по факту прохождения шага клиентом в конкретном сценарии. Например, если это сообщение клиента в чат-боте, то мы получаем: текст сообщения, время отправки, id отправителя.
Данные шагов для клиента становятся доступны после того, как вы запустите сценарий, и клиент пройдет его шаги. Их можно использовать для настройки фильтров в сценарии, обновлении переменных клиента в профиле, подстановки значений в сообщения и другое.
Обратите внимание, что данные шагов клиента в сценарии — это не значения переменных этого клиента, записанные в профиле. Данные шагов сохраняются в рамках конкретного сценария после прохождения его клиентом — это называется сессия клиента. Если сессию прохождения сценария для одного или всех клиентов очистить, значения данных шагов для этих клиентов удалятся.
Примеры:
1. Обновление данных клиента в профиле VK CXhub после получения данных из профиля ВК — в этом случае на шаге обновления переменных клиента необходимо использовать данные шага получения этих значений из профиля ВК.
Подробнее об этом можно прочесть в инструкции.
2. Значение данных шагов как условие для запуска определенной ветки сценария — в этом случае через данные шагов настраиваем соответствие нужному значению в фильтре при настройке условия проверки. Например, чтобы отправить клиенту уведомление об успешном платеже, необходимо проверить статус платежа, и сформировать сообщение для клиента в том случае, если платеж успешно прошел. Для этого настраивается фильтр с помощью данных шага «Проверка статуса платежа»: статус платежа — Равно succeeded:
В качестве примера можно посмотреть шаблон «Приём платежей через ЮКасса в мессенджере». Инструкция к данному шаблону https://help.apicxhub.ru/integratsiya-s-yukassa#priem-plategey-cherez-yukassa-v-messendgere
3. Бот отправляет клиенту сообщение со сгенерированным ИИ текстом — в этом случае для настройки текста сообщения бота необходимо использовать данные шага генерации текста.
Данные шагов состоят из переменных и их значений. Названия переменных будут одинаковыми для всех клиентов в рамках сценария, а значения — индивидуальные для каждого клиента.
Данные шагов состоят из переменных и их значений. Названия переменных будут одинаковыми для всех клиентов в рамках сценария, а значения могут быть индивидуальны для каждого клиента в зависимости от типа шага (например, если на шаге формируется ссылка на оплату, она будет своя для каждого клиента, а если на шаге получаем данные о лидформе, то, например, значение поля с названием лидформы будет единое для всех клиентов).
Для того, чтобы использовать данные шагов в настройках шага в вашем сценарии, можно воспользоваться одним из способов:
Достаточно, чтобы хотя бы один клиент прошел сценарий. После этого появятся переменные и значения шагов по нему, и вы сможете использовать эти данные для настройки последующих шагов сценария.
Важно! Если очистить сессию клиента, данные шагов удалятся, и не получится найти необходимые переменные для дальнейшей настройки. Не удаляйте сессию клиента пока не завершите настройку шагов, где используются полученные данные.
Важно! Если очистить сессию клиента, данные шагов удалятся, и не получится найти необходимые переменные для дальнейшей настройки. Не удаляйте сессию клиента пока не завершите настройку шагов, где используются полученные данные.
Мы подготовили для вас примеры данных шагов, которые вы можете использовать для подстановки переменных. В данном случае вам не нужно будет запускать сценарий, чтобы получить переменные, которые вы хотите использовать.
Для вашего удобства примеры данных шагов содержат только те переменные, которые наиболее часто используются для подстановки, и не содержат ряд технических переменных. Но если вам необходимо использовать какую-то переменную, которой нет в примере данных шагов, вы можете воспользоваться вариантом «Использовать реальные данные», где после прохождения сценария пользователем появится список всех переменных, которые возвращаются в ответе на запрос.
Для реальных данных и примеров данных единый алгоритм работы с ними:
1. Зайти в окно редактирования шага, в который необходимо подставить данные шагов.
2. Нажать на поле, в которое планируется подстановка.
3. В появившемся окне по умолчанию открыта вкладка «Данные из шагов сценария».
4. Выбрать «Пример данных» или «Реальные данные».
5. В списке шагов найти шаг, данные которого необходимо использовать (для реальных данных сценарий должен быть пройден клиентом) или настройки фильтра, в котором будут использованы данные шагов.
6. В раскрывающемся списке переменных шага найти необходимую переменную.
7. Нажать на переменную в списке, чтобы она появилась в выбранном поле шага.
8. Сохранить шаг.