Опис блоків (група Загальні)

1. Група Загальні складається з блоків: блок Початок
2. блок Кінець
3. блок Таймер
4. блок Завдання
5. підтвердити контакт
6. створити контакт
7. оновити контакт
8. обов'язковий email
9. отримати Промокод
10. створити промокод
11. Отримати замовлення
12. Покинуті перегляди по email
13. Покинуті кошика по email
14. Рекомендації по email
15. отримати контакт
16. запустити подія
17. блок Умова
18. перевірити подія
19. Мінлива відповідає регулярному виразу
20. Контакт підтверджений
21. Контакт існує
22. Читати далі

Група Загальні складається з блоків:

блок Початок

Наша взаимовыгодная связь https://banwar.org/

Обов'язковий блок, який завжди ставиться на початку сценарію. Без цього блоку сценарій не почне працювати. В одному сценарії може бути тільки один блок старту.

У даного блоку передбачений додатковий функціонал - перед виконанням кожного наступного блоку в сценарії - перевірити відбулося чи ні потрібну подію за період з моменту запуску сценарію.

Пошук подій проводиться по ключам. В поле key вказується ключ унікальності події, найчастіше в цьому параметрі передається емейл або id контакту. У випадаючому списку "Вихід за подією" вибирається перевіряється подія.
Якщо подія буде зафіксовано, відбудеться примусове завершення роботи сценарію. Інакше, виконання продовжиться і перевірка повториться перед наступним блоком.

блок Кінець

Обов'язковий блок, може використовуватися кілька разів. Без цього блоку сценарій не спрацює. Блок означає закінчення (завершення) сценарію. Всі шляхи (гілки) сценарію обов'язково повинні закінчуватися блоком Кінець.

блок Таймер

Блок використовується для створення затримки в роботі сценарію. Це по суті пауза, після якої сценарій триває.

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

Наприклад, людина підписався на розсилку. Сценарій запуститься, система почекає 1 хвилину і отруїть перший лист. Після цього почекає 1 день і відправить другий лист. На цьому сценарій закінчиться.
У даного блоку є 3 параметри:

• почекати
• Надіслати
• час відправки

Для роботи блоку Таймер необхідно вибрати хоча б один параметр.

параметр Почекати

У цьому параметрі можна вибрати скільки необхідно почекати, щоб сценарій пішов далі. Це можуть бути хвилини, години, дні, місяці. Відповідно задаємо кількість хвилин, годин, днів, місяців.

Важливий момент! Якщо ви вибираєте почекати 1 (2,3) день, це означає, що сценарій піде далі через 24 (48, 72) години з моменту спрацьовування сценарію. Якщо клієнт підписався на вашу розсилку о 15:00, то лист він отримає о 15:00 наступного дня.

Параметр Надіслати.

Параметр в якому вибирається день відправки. Це хороший варіант для запуску регулярних автоматичних розсилок.
Важливий момент! Якщо сьогодні середа, а ви вибрали відправити в понеділок - лист буде відправлено наступного понеділка (тобто через кілька днів). Якщо сьогодні п'ятниця - клієнт отримає лист сьогодні.

Параметр Час відправки

Працює за принципом параметра Надіслати. Якщо ви виставили час відправки 8:45 а сценарій запустився о 15:00, то клієнт отримає лист о 8:45 наступного дня.
Ви можете вибрати один або кілька параметрів для налаштування блоку Таймер.

Важливий момент! Зверніть увагу на логіку роботи даного блоку.
Наприклад, ви вибрали такі параметри:

• почекати 1 день
• відправити в понеділок
• час відправки 7:45.

Сценарій запустився в неділю о 15:00. Система чекає 1 день (24 години). Настає понеділок. Час закінчення роботи параметра "Почекати 1 день" в нашому прикладі 15:00 у понеділок. Система перевіряє параметр "Надіслати". У нас обраний понеділок і сьогодні понеділок. Поки все добре. Система перевіряє параметр "Час відправки". Умовами задано 7:45, а зараз 15:00. Умови не спрацювали. Це означає, що клієнт отримає не в цей понеділок лист, а тільки в наступний о 7:45.
Уважно виставляйте параметри!

блок Завдання

Мета цього блоку - вирішити певне завдання.

Всього в системі на даний момент є 12 завдань:

підтвердити контакт

Мета завдання - підтвердити email-адреса передплатника і зробити його активним в системі.

Наприклад, коли людина заповнює форму підписки - контакт потрапляє в eSputnik з непідтвердженими email, йому на пошту приходить повідомлення з проханням підтвердити підписку. Поки людина не перейде по посиланню підтвердження, контакт буде залишатися в системі непідтвердженими і отримувати розсилки не буде. Коли людина підтверджує підписку - запускається сценарій підтвердження. Спрацьовує завдання Підтвердити контакт, і контакт ставати в системі активним.
Ось так виглядає найпростіший сценарій підтвердження контакту.

У даній задачі 2 параметра:

• Email контакту - У цьому полі за замовчуванням використовується змінна $ {EmailAddress}, тому ви можете залишити це поле порожнім. Ви змінюєте її тільки якщо створюєте свою змінну в якій міститься email людини.
• ID контакту - Якщо ви хочете підтвердити контакт не по email, а по його id в системі - прописуєте назву змінної, в якій міститься id контакту. За замовчуванням в системі вона називається $ {ContactId}.

створити контакт

Завдання використовується для створення контакту в системі. Якщо контакт з таким email-адресою вже є, він буде оновлений. Якщо ні - буде створено новий контакт.

Важливо! При підписці або передачі контакту будь-яким спеціалізірвоанним методом API, контакт створюється без цього блоку. Цей блок потрібен тільки для дуже специфічних завдань коли необхідно передати дані по контакту в подію методом / v1 / event.

У завдання є 2 параметри:

• email - обов'язкове поле для завдання. За замовчуванням там вже прописана змінна $ {email}. Тому якщо у вас в подію інша назва змінної, то треба вписати в поле правильна назва.
• json - в цьому полі прописується рядок або ставиться змінна, що містить рядок у форматі JSON з даними для заповнення полів контакту (телефон, ім'я, прізвище, місто, додаткові поля). Формат даних нижче.

Приклад даних для поля json:

{ "Firstname": "...", "lastname": "...", "sms": "...", "town": "...", "profileInputs":
[{ "ProfileInputId": 10001, "value": "..."}]}

де profileInputs - масив додаткових полів, profileInputId - id додаткового поля, value - значення додаткового поля, confirmed - статус email-адреса контакту (підтверджений / не підтверджений).
Важливо!
Якщо ви хочете створити контакт непідтвердженими, то в тіло запиту потрібно додати параметр "confirmed": false
У цьому випадку поле json матиме таку структуру.
{ "Firstname": "...", "lastname": "...", "sms": "...", "town": "...", "profileInputs":
[{ "ProfileInputId": 10001, "value": "..."}], "confirmed": false}
Якщо потрібно створити контакт з деяким значенням поля типу дата, тоді використовуйте формат виду: "DD / MM / YYYY"
{ "ProfileInputs": [{ "profileInputId": 10001, "value": "11/06/2011"}]}
Якщо потрібно створити контакт з деяким значенням поля типу дата згодом, тоді використовуйте формат виду: "DD / MM / YYYY HH: mm"
{ "ProfileInputs": [{ "profileInputId": 10001, "value": "11/06/2011 16:42"}]}

оновити контакт

Завдання використовується для оновлення інформації контакту в системі, працює за принципом завдання створити контакт . Єдина різниця - в разі якщо контакт вже є в системі, то він оновиться, а якщо немає - система пропустить завдання і контакт створений не буде.

Завдання актуальна якщо треба оновити дані контакту з події переданого по API методом / v1 / event або якщо треба в сценарії задавати фіксоване значення додаткового поля.

У завдання є 2 параметри:

• email - обов'язкове поле для завдання. За замовчуванням там вже прописана змінна $ {email}. Тому якщо у вас в подію інша назва змінної, то треба вписати в поле правильна назва. У наших системних подіях змінна називається EmailAddress, відповідно в поле треба вписати $ {EmailAddress}.
• json - в цьому полі прописується рядок або ставиться змінна, що містить рядок у форматі JSON з даними для заповнення полів контакту (телефон, ім'я, прізвище, місто, додаткові поля). Формат даних такої ж, як і для задачі створити контакт , Але параметр confirmed ігнорується.

обов'язковий email

Мета завдання - відправити лист контакту незважаючи на його статус в системі. Тобто ви зможете відправити лист всім (підтвердженим, непідтвердженими, відписав, в спам), крім контактів з чорного списку.

Важливо! Чи не іспользойте без надобнобності цей блок. Оскільки він ігнорує статус контакту можливі скарги на спам. Даний блок потрібен тільки для відправки новому (ще непідтверджені) передплатнику листи з кнопкою підтвердження підписки. У всіх інших випадках для відправлення листа використовуйте блок Email .

У блоку є 4 параметра:

• Повідомлення - обов'язкове поле. Виберіть заздалегідь створене лист, який повинен відправитися.
• Email контакту - поле для введення параметра з події, в якому передається email-адреса одержувача. За замовчуванням в це поле ставиться стандартний параметр з системних подій eSputnik $ {EmailAddress}.
• ID Контакту - ідентифікатор контакту в системі eSputnik. Може використовуватися для ідентифікації отримувача замість email-адреси.
• JSON - довільні дані в Формат, МА JSON, які передаються в лист. Якщо в параметрі в подію ви передаєте рядок з такими даними, в це поле треба вставити цей параметр.

отримати Промокод

Блок витягує з бази черговий промокод і передає в лист. Детальніше про промокодом .

У завдання 3 параметра (всі обов'язкові):

• days - кількість днів, протягом яких промокод ще повинен бути чинним
• type - заданий вами для сегментації тип промокодом
• discount - розмір знижки від 0 до 99.

Принцип роботи розглянемо на прикладі. В параметрах зазначимо наступні дані:

• days - 10
• type - newyear
• discount - 25

Це означає, що сценарій витягне промокод зі знижкою 25%, який знаходиться в групі newyear і термін дії якого не менше 10 днів. Якщо під цей критерій потрапляє кілька промокодом - система сама вибере один з них.

За блоком "Отримати Промокод" в сценарії стаітся блок відправки повідомлення (Email або SMS). У листі на місці промокодом треба використовувати змінну $! Data.get ( 'promocode').

створити промокод

Мета завдання - створити (згенерувати) промокод і передати його в лист, яке йде наступне по ланцюжку. В такому випадку промокод згенерує система eSputnik і передасть дані в лист. Детальніше .

У завдання 4 параметра:

• days - вказується кількість днів до закінчення дії промокодом.
• type - вказується число від 0 до 31.
• discount - розмір знижки. Якщо ви хочете згенерувати промокод по якій ви даруєте подарунок клієнту - в поле discount ставите 0.
• key - ключ шифрування. Можна не міняти і залишити за замовчуванням.

Всі параметри обов'язкові для заповнення.
За цим блоком в сценарії стаітся блок відправки повідомлення (Email або SMS). У листі на місці промокодом треба використовувати змінну $! Data.get ( 'promocode').

Отримати замовлення

Мета завдання - витягнути дані про замовлення і передати їх в лист. Завдання актуальна тільки в разі, коли ви передаєте дані про замовлення в eSputnik методом API . Детальніше по роботі з замовленнями .

Завдання може використовуватися в сценаріях повідомлення клієнта про замовлення, доставки і т.д. Тобто всюди, де необхідні дані про замовлення.
Завдання працює так:

• в систему надходять дані про замовлення
• даний блок витягує всі дані, які передаються із замовленням
• витягнуті дані передаються в лист

Покинуті перегляди по email

Мета завдання - витягнути дані веб-перегляду товари і передати їх в лист. Завдання актуальна тільки якщо ви передаєте дані про кинутих переглядах в eSputnik через систему Softcube. Детальніше .

Завдання працює наступним чином:

• в систему надходять дані про кинутих переглядах
• блок витягує всі дані, які передаються з кинутим переглядом.
• отримані дані передаються в лист.
• в листі вказується кілька переглянутих товарів і кілька рекомендацій.

У завдання є 4 обов'язкових параметра:

• tenantId - залиште без змін
• apiKey - залиште без змін
• blockId - службовий параметр. Правильне значення вам повідомить служба підтримки
• email - email користувача, який кинув перегляд. Зазвичай в цьому полі повинен бути параметр $ {contacts}

Покинуті кошика по email

Мета завдання - витягнути дані про незавершене замовленні і передати їх в лист. Завдання актуальна тільки якщо ви передаєте дані про кинутих кошиках в eSputnik через систему Softcube. Детальніше .

Працює аналогічно завдання Покинуті перегляди по email:

• в систему надходять дані про незавершене замовленні
• блок витягує всі дані, які передаються з незавершеним замовленням.
• отримані дані передаються в лист.

У завдання є 4 обов'язкових параметра:

• tenantId - залиште без змін
• apiKey - залиште без змін
• blockId - службовий параметр. Правильне значення вам повідомить служба підтримки
• email - email користувача, який кинув перегляд. Зазвичай в цьому полі повинен бути параметр $ {contacts}

Рекомендації по email

Мета завдання - передати дані з рекомендаціями в лист.

Завдання працює по то тим же принципом, що і Покинуті перегляди по email і Покинуті кошика по email . Тільки замість інформації веб-перегляду або незакінчену замовленні витягується інформація з рекомендаціями.

У завдання є 4 обов'язкових параметра:

• tenantId - залиште без змін
• apiKey - залиште без змін
• blockId - службовий параметр. Правильне значення вам повідомить служба підтримки
• email - email користувача, який кинув перегляд. Зазвичай в цьому полі повинен бути параметр $ {contacts}

отримати контакт

Мета завдання - витягнути дані про контакт і передати їх в лист або для блоку Умова . Наприклад, ми хочемо кожен раз отримувати лист-повідомлення з контактними даними, коли у нас з'являється новий передплатник. Другий варіант - ми хочемо після реєстрації надіслати клієнту його реєстраційні дані.

Завдання працює наступним чином:

• в системі створюється (реєструється) подія, яка містить дані про контакт
• блок витягує всі дані по контакту, які зберігаються в базі
• отримані дані передаються в лист

У блоку є 4 параметра:

• ContactId - id контакту в системі eSputnik
• EmailAddress - email-адреса контакту
• Phone - номер телефону контакту.
• MobPushToken - мобільний токен контакту.

Параметри Email контакту, ID контакту, Phone і MobPushToken використовуються для вибору способу ідентифікації контакту. Одне з цих полів має бути обов'язково заповнене відповідними даними.
Наприклад, якщо ви хочете ідентифікувати людину не по email, а по його id в системі - прописуєте назву змінної, в якій міститься id контакту. За замовчуванням в системі вона називається $ {ContactId}.

У листі можна використовувати такі змінні:

• $! Data.get ( 'firstName') - ім'я
• $! Data.get ( 'lastName') - прізвище
• $! Data.get ( 'email') - email-адреса
• $! Data.get ( 'sms') - номер телефону
• $! Data.get ( 'contactKey') - ключ контакту
• $! Data.get ( 'id') - id контакту в системі
• $! Data.get ( 'createdDate') - дата створення
• $! Data.get ( 'updatedDate') - дата останнього зміни контакту
• $! Data.get ( 'confirmed') - статус email-адреси контакту (true - підтверджений, false - не підтверджений)
• $! Data.get ( 'fields'). Get ( '12345') - додаткові поля. 12345 - id додаткового поля.

запустити подія

Мета завдання - запустити будь-яку подію з сценарію. Наприклад, щоб з одного сценарію запустити інший. Для використання завдання попередньо потрібно створити тип подій, який ми плануємо запустити.

У завдання є 3 параметри:

• eventTypeId - Обов'язкове поле. У ньому необхідно вибрати тип подій, який ми хочемо запустити
• keyValue - ключ події, яке ми хочемо запустити. Наприклад, тут може бути змінна, яка містить email. Якщо полі не запролнено - буде використовуватися ключ з події, яке запустило поточний сценарій
• params - масив параметрів, які ми хочемо передати в запускається подія. Якщо не заповнено - будуть передані параметри з події, що запустив поточний сценарій. Формат параметрів такої:
  [{ "Name": "paramName," value ":" значення параметра "}]

блок Умова

Мета блоку - перевірити виконуються певні умови сценарію чи ні. Залежно від цього подальший хід сценарію розділяється на дві гілки:

• якщо так - сценарій виконує одну дію
• якщо немає - інше

Блок має один вхід і 2 виходи (один - якщо Так, другий - якщо Ні).
У блоку є 5 завдань:

перевірити подія

Мета завдання - перевірити відбулося потрібну подію чи ні за період з моменту запуску сценарію. Пошук подій проводиться по ключам.

У завдання є 2 параметри:

• Ключ - який ключ події шукати. Наприклад, в якості ключів перевіряються подій використовується email-адреса. Таким чином в цьому полі повинен бути параметр, що містить email-адреса. Це параметр з події, що запустив поточний сценарій. Якщо він називається Email Address, то в поле треба написати $ {EmailAddress}
• Тип події - тип подій, які перевіряти

Мінлива відповідає регулярному виразу

Мета завдання - перевірити певну змінну з події або отримані іншими блоками дані і в залежності від цього скорегувати подальший хід сценарію.

Наприклад, ми можемо перевірити хто наш користувач - чоловік чи жінка і виходячи з цього скорегувати хід сценарію.

У завдання є 2 параметри:

• name - назва змінної, яку необхідно перевірити. Це може бути параметр з події. Зауважте, що в цьому полі назву параметра записується без $ {}.
  Якщо ж ми перевіряємо дані, отримані іншими блоками сценарію, то треба використовувати системну змінну smartMessageJson.
• pattern - регулярний вираз на відповідність з яким перевіряємо дані. Наприклад, хочемо перевірити що параметр "address" з події містить текст Київ. В цьому випадку в pattern прописуємо. * Київ. *

Контакт підтверджений

Мета завдання - перевірити підтверджений чи імейл контакту чи ні і в залежності від цього скорегувати подальший хід сценарію.

Як працює дана задача
Наприклад, людина зареєструвався на сайті або підписався на вашу розсилку. Ви хочете відправити йому вітальний лист.
В цьому випадку:

• контакт з'являється в базі eSputnik, але знаходиться в статусі непідтверджений;
• людині відправляється лист з проханням підтвердити реєстрацію;
• задача перевіряє підтвердив чоловік реєстрацію чи ні;
• якщо підтвердив - сценарій йде по гілці Та й відправляється вітальний лист;
• якщо ще не підтвердив реєстрацію - сценарій йде по гілці Ні.

У завдання є 2 параметри:

• EmailAddress - email-адреси контакту
• ContactId - id контакту в системе

За замовчуванням система перевірять підтверджений контакт чи ні по email. Якщо ви хочете, щоб ідентифікація йшла по id контакту, необхідно в поле ContactId вписати змінну $ {ContactId}.

Контакт існує

Мета завдання - перевірити чи існує контакт чи ні і в залежності від цього скорегувати подальший хід сценарію. Працює аналогічно завданню Контакт підтверджений.

У даній задачі є 2 параметри:

За замовчуванням система перевіряє існує контакт чи ні по email. Якщо ви хочете, щоб ідентифікація йшла по id контакту, необхідно в поле ContactId вписати змінну $ {ContactId}.

Читати далі

Частина 2. Опис блоків (група Дії)

Частина 3. Опис блоків (група Умови)