Поля сценария

Поля сценария - временные поля с информацией, которые предварительно создаются в мастере создания сценария, и передаются в API-запросе на старт сценария.

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

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

Для использования полей сценария создайте их предварительно в окне редактирования сценария.

Укажите название поле и его тип. Обратите внимание, что от указанного типа будут зависеть возможности работы с данным полем: математические операции и операции сравнения доступны только для числовых полей, а использование поля в блоке «Пауза» доступно только для типов дата и дата-время.

После создания поля вы можете передать его с необходимым значением в методе /v1/event/start/{scenarioId}/{blockId}/ (параметр scenarioFields).

Поля сценария можно использовать в блоках:

• распределение - контакты можно направить по разным веткам сценария через блок «Распределение» в зависимости от значений в их полях сценария;
• изменение данных - значения полей сценария для контактов можно задать, перезаписать или очистить в процессе прохождения сценария;
• API-запрос - допускается подстановка полей сценария в:
  • URL,
  • тело,
  • заголовки,
  • параметры;
• пауза - можно поставить контакт на паузу, в которой он будет ожидать наступления даты в поле сценария или заданное время до/после значения даты в поле сценария.

Например, вы можете составить цепочку с напоминаниями о событии с помощь блоков «Пауза до даты в поле сценария» и отправки сообщений в разные каналы:

1. Передать контакт с датой начала мероприятия
2. Поставить на паузу «ждать 3 дня до даты в поле сценария»
3. После паузы поставить блок отправки емейл-сообщения с напоминанием о событии
4. Снова пауза «ждать 1 день до даты в поле сценария»
5. Отправка WhatsApp сообщения с напоминанием
6. Пауза «ждать 1 час до даты в поле сценария»
7. СМС с напоминанием о начале события

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

Вы можете выводить значение полей сценария в сообщения этого сценария с помощью метода динамического контента {{scenarioField.Name}}, где Name - название поля, заданное при его создании.

Например, вы можете передать в начальном API-запросе поля в виде:

"scenarioFields": {
   "eventname": "Вебинар по SQL",
   "eventurl": "https://events.sql.ru/"
}

и вывести их значение в емейл-сообщение с помощью методов ДК в виде:

• {{scenarioField.eventname}}
• {{scenarioField.eventurl}}

соответственно.

Пользователь получит сообщение вида:

«Здравствуйте! Вы записались на событие «Вебинар по SQL». Ссылка на мероприятие: https://events.sql.ru/»