Перейти к основному содержимому

Общая информация

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

Одной из базовых возможностей Sailplay является работа с переменными клиентов.

Переменная — это ключевая фраза, которая при отправке сообщения заменяется сохранённым значением.
Например, переменная $[first_name] будет автоматически подставлена именем получателя.

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

Переменные поддерживаются:

  • в массовых Email, 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.

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

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

Получение списка переменных​

Метод:

/api/v2/users/custom-vars/list/

возвращает список всех созданных пользовательских переменных, независимо от их привязки к конкретному клиенту.