Подстановка промокода с использованием API
Рассмотрим, как передавать промокоды в триггерные сообщения с помощью API-методов:
- Generate event (через сценарий),
- Send prepared message (без использования сценария).
Метод Generate event
Метод Generate event служит для передачи в eSputnik любых кастомных событий, которые могут использоваться для запуска сценария.
Чтобы подставить в триггерное сообщение промокод, переданный по API, выполните следующие действия:
- Настройте передачу необходимых параметров в событии.
- Добавьте переменную в сообщение.
- Создайте сценарий.
1. Настройка параметров события
Событие должно содержать промокод и идентификатор контакта, который будет использован для отправки сообщения (например, email для отправки письма или номер телефона для SMS).
Параметры события:
{ "params": [ { "name": "EmailAddress", "value": "mail@example.com", }, { "name": "code", "value": "ABC-123" } ] }
JSON
, где code — название переменной, которое будет использоваться в сообщении, а ABC-123 — сам промокод, который получит контакт.
2. Подстановка переменной в сообщение
Вставьте в сообщение название переменной, которая содержит промокод, в формате $!data.get('code'). Вместо переменной контакт увидит промокод, переданный в событии.
3. Создание сценария
В параметрах сообщения в сценарии укажите параметр из события, в котором содержится идентификатор контакта для отправки сообщения (в нашем примере это email-адрес, для других каналов используйте соответствующие идентификаторы).
Подробнее о настройках запуска сценария по событию читайте в инструкции.
Метод Send prepared message
Метод Send prepared message используется для отправки подготовленного сообщения одному или нескольким контактам.
Вы можете отправить уникальный промокод каждому контакту.
Формат запроса:
{ "recipients": [{ "locator": "mail@example.com", "jsonParam": "{\"code\":\"ABC-123\"}" }], "email": true }
JSON
, где recipients — массив с получателями, в каждом элементе которого есть параметр jsonParam. Его можно использовать для передачи в сообщение любых данных, в т. ч. промокода. Данные для сообщения должны быть в JSON-формате, преобразованном в строку.
В запросе https://esputnik.com/api/v1/message/{id}/smartsend вместо {id} ужно использовать ID сообщения, которое должно быть отправлено.
В сообщении используйте переменную в формате $!data.get('code').