Переменные клиентов

Переменные и их типы

Одной из базовых возможностей Sailplay является возможность назначать пользователям переменные. Переменная - ключевая фраза, которая при отправке письма будет заменена сохраненным значением. Например, переменная $[first_name] при отправке будет заменена на имя получателя.

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

Использовать переменные можно, как в массовых E-mail, Push и SMS-рассылках, так и в триггерных Email, Push и SMS-сообщениях. Указывать переменные вы можете не только непосредственно в теле письма, но и, например, в заголовке или URL-адресе.

В системе Sailplay реализовано два типа переменных:

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

Методы для работы с переменными

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

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

Добавление новой переменной клиенту осуществляется вызовом метода /api/v2/users/custom-vars/add/. Список переменных передается в параметре "vars" в формате "ключ (имя переменной) - значение (данные переменной)" в виде JSON строки:

&vars={"var_name1":"value1","var_name2":"value2"}

🚧

Важно

При передаче в значении переменной длинной строки (например, HTML код) рекомендуется передавать параметр vars в POST части запроса.

Получение / удаление переменной

Получение значения и удаление переменной осуществляется по ее ключу (имени) передаваемому в параметре name.

Используемые методы:

• /users/custom-vars/get/ - получение значения переменной для клиента
• /users/custom-vars/get/batch/ - получение значения множества переменных для клиента
• /users/custom-vars/delete/ - удаление пользовательской переменной

Отдельно стоит выделить метод /users/custom-vars/list, возвращающий список всех созданных переменных независимо от привязки к клиенту.