Параметры /createMessage

Здесь вы найдете описания параметров API-метода /createMessage. Обязательные параметры обеспечивают успешную отправку API-запроса /createMessage и отправку широковещательного push-уведомления в указанное время. Необязательные параметры позволяют гибко настраивать свойства push-уведомлений.

Обязательные параметры

Обязательные параметры необходимо использовать в запросах /createMessage. В противном случае запрос не будет отправлен.

application

Уникальный код приложения, созданного в вашем аккаунте Wavesend. Код приложения можно найти в левом верхнем углу Control Panel или в ответе на запрос /createApplication. Код приложения представляет собой разделенный дефисами набор из 10 символов (букв и цифр).

При создании приложения через API вы получите код приложения в ответе на ваш запрос /createApplication.

Чтобы получить код ранее созданного приложения через API, вызовите метод /getApplications. В ответе на запрос /getApplications вы получите список всех приложений, созданных в вашем аккаунте Wavesend, с их названиями и кодами.

auth

API Access token из Control Panel Wavesend. Перейдите в Settings → API Access и скопируйте токен, который хотите использовать, или сгенерируйте новый.

При создании токена доступа укажите его разрешения. Установите флажки для тех видов деятельности, для которых вы собираетесь использовать API token. Вы можете создать API token, специфичный для конкретного приложения, установив флажки в разделе Applications.

content

Строка или объект для определения содержимого сообщения. Параметр “content”, переданный со значением строкового типа, отправит одинаковое сообщение всем получателям.

"content": "Hello world!",

Объекты JSON используются для указания содержимого с помощью Dynamic Content, например, для сообщений на нескольких языках.

"content": {
  "en": "Hello!",
  "es": "¡Hola!",
  "de": "Hallo!"
},

notifications

Массив JSON со свойствами push-уведомления. Должен содержать как минимум обязательные параметры “content” и “send_date”.

Необязательные параметры для использования в массиве “notifications”:

campaign
capping_days
capping_count
conditions
data
devices
dynamic_content
filter
ignore_user_timezone
inbox_date
inbox_image
link
minimize_link
platforms
preset
rich_media
send_rate
timezone
template_bindings
transactionId
users

send_date

Дата и время отправки сообщения. Может быть любой датой и временем в формате ГГГГ-ММ-ДД ЧЧ:мм или ‘now’. Если установлено значение ‘now’, сообщение будет отправлено сразу после отправки запроса.

Необязательные параметры

campaign

Код Campaign. Чтобы получить код Campaign, перейдите в Channels → Statistics и выберите Campaign, которую собираетесь использовать. Код кампании можно найти в конце URL-адреса страницы после campaigns-statistic. Это разделенный дефисами набор из 10 символов (букв и цифр).

Чтобы получить список Campaign с их кодами, вызовите метод /getCampaigns. В ответе на запрос /getCampaigns вы получите список всех Campaign, созданных для конкретного приложения в вашем аккаунте Wavesend, с их кодами, названиями и описаниями.

capping_days

Период, применяемый для Frequency capping, в днях (максимум 30 дней).

capping_count

Максимальное количество push-уведомлений, которое может быть отправлено из конкретного приложения на определенное устройство в течение периода “capping_days”. Если созданное сообщение превышает лимит “capping_count” для устройства, оно не будет отправлено на это устройство.

conditions

conditions — это массивы вида [tagName, operator, operand], используемые для отправки таргетированных сообщений на основе Tags и их значений, где:

tagName — имя Tag для применения,
operator — оператор сравнения значений (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
operand — значения Tag любого из следующих типов: string | integer | array | date | boolean | list

Описание операторов

EQ: значение Tag равно операнду;
IN: значение Tag пересекается с операндом (операнд всегда должен быть массивом);
NOTEQ: значение Tag не равно операнду;
NOTIN: значение Tag не пересекается с операндом (операнд всегда должен быть массивом);
GTE: значение Tag больше или равно операнду;
LTE: значение Tag меньше или равно операнду;
BETWEEN: значение Tag больше или равно минимальному значению операнда, но меньше или равно максимальному значению операнда (операнд всегда должен быть массивом);
NOTSET: Tag не установлен. Операнд не учитывается;
ANY: Tag имеет любое значение. Операнд не учитывается.

Строковые теги

Допустимые операторы: EQ, IN, NOTEQ, NOTIN, NOTSET, ANY
Допустимые операнды:

EQ, NOTEQ: операнд должен быть строкой;
IN, NOTIN: операнд должен быть массивом строк вида ["value 1", "value 2", "value N"];
NOTSET: Tag не установлен. Операнд не учитывается;
ANY: Tag имеет любое значение. Операнд не учитывается.

Числовые теги

Допустимые операторы: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY
Допустимые операнды:

EQ, NOTEQ, GTE, LTE: операнд должен быть целым числом;
IN, NOTIN: операнд должен быть массивом целых чисел вида [value 1, value 2, value N];
BETWEEN: операнд должен быть массивом целых чисел вида [min_value, max_value];
NOTSET: Tag не установлен. Операнд не учитывается;
ANY: Tag имеет любое значение. Операнд не учитывается.

Теги даты

Допустимые операторы: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY
Допустимые операнды:

"YYYY-MM-DD 00:00" (строка)
unix timestamp 1234567890 (целое число)
"N days ago" (строка) для операторов EQ, BETWEEN, GTE, LTE

Логические теги

Допустимые операторы: EQ, NOTSET, ANY
Допустимые операнды: 0, 1, true, false

Теги-списки

Допустимые операторы: IN, NOTIN, NOTSET, ANY
Допустимые операнды: операнд должен быть массивом строк вида ["value 1", "value 2", "value N"].

conditions_operator

Логический оператор для массивов conditions. Возможные значения: AND | OR. По умолчанию используется AND.

Если применяется оператор AND (когда оператор не указан или параметр ‘conditions_operator’ имеет значение ‘AND’), push-уведомление получат устройства, одновременно соответствующие всем условиям.

Если оператор — OR, сообщение получат устройства, соответствующие любому из указанных условий.

data

Строка JSON или объект JSON, используемый для передачи любых Custom data в полезной нагрузке push-уведомления; передается как параметр «u» в полезной нагрузке (преобразуется в строку JSON).

devices

Массив push-токенов или HWID для отправки таргетированных push-уведомлений. Если параметр установлен, сообщение будет отправлено только на устройства из списка.

dynamic_content

Плейсхолдеры для Dynamic Content, которые будут использоваться вместо значений Tag устройства. Пример ниже отправит сообщение «Hello, John!» каждому пользователю, на которого вы нацелены. Если не установлено, значения Dynamic Content берутся из Tag устройства.

"content": "Hello, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "John",
  "lastname": "Doe"
},

filter

Название Segment в точности так, как оно создано в Control Panel Wavesend или через API-запрос /createFilter. Перейдите в раздел Audience → Segments (Filters) и просмотрите список созданных Segment.

Чтобы получить список Segment через API, вызовите API-метод /listFilters. В ответе на запрос /listFilters вы получите список всех Segment, созданных в вашем аккаунте Wavesend, с их названиями, условиями и датами истечения срока действия.

ignore_user_timezone

Если установлено значение ‘true’, сообщение отправляется в дату и время, указанные в параметре “send_date”, в соответствии с UTC-0.

Если установлено значение ‘false’, пользователи получат сообщение в указанное местное время в соответствии с настройками их устройства.

inbox_date

Дата, до которой сообщение должно храниться в Inbox пользователей. Если не указано, сообщение будет удалено из Inbox на следующий день после даты отправки.

inbox_image

URL-адрес пользовательского изображения, которое будет отображаться рядом с сообщением в Inbox.

inbox_days

Срок жизни сообщения в Inbox в днях, до 30 дней. По истечении этого периода сообщение будет удалено из Inbox. Может использоваться вместо параметра inbox_date.

link

URL-адрес, который будет открыт после того, как пользователь откроет push-уведомление.

minimize_link

Сокращатель для минимизации URL-адреса, переданного в параметре “link”. Обратите внимание, что размер полезной нагрузки push-уведомления ограничен, поэтому рассмотрите возможность создания коротких URL-адресов, чтобы не превышать лимит. Доступные значения: 0 — не минимизировать, 2 — bitly. По умолчанию = 2. Сокращатель URL-адресов Google отключен с 30 марта 2019 года.

platforms

Массив кодов платформ для отправки сообщения только на определенные платформы. Список доступных платформ: Доступные коды платформ включают: 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — Email, 17 — Huawei, 18 — SMS и 21 — WhatsApp.

preset

Код Preset, созданного в Control Panel Wavesend или через API. Чтобы получить код пресета, перейдите в Content → Presets, разверните Preset, который собираетесь использовать, и скопируйте Preset Code из его деталей.

rich_media

Код страницы Rich Media, которую вы собираетесь прикрепить к своему сообщению. Чтобы получить код, перейдите в Content → Rich Media, откройте страницу Rich Media, которую собираетесь использовать, и скопируйте код из адресной строки вашего браузера. Код представляет собой разделенный дефисами набор из 10 символов (букв и цифр).

send_rate

Регулирование для ограничения скорости отправки push-уведомлений. Допустимые значения — от 100 до 1000 push-уведомлений в секунду.

timezone

Часовой пояс, который следует учитывать при отправке сообщения в определенную дату и время. Если он установлен, часовой пояс устройства игнорируется. Если он не указан, сообщение отправляется в UTC-0. Список поддерживаемых часовых поясов см. по адресу https://php.net/manual/timezones.php.

template_bindings

Плейсхолдеры шаблона для использования в вашем шаблоне контента. Подробнее см. в руководстве Liquid Templates.

transactionId

Уникальный идентификатор сообщения для предотвращения дублирования сообщений в случае проблем с сетью. Вы можете присвоить любой ID сообщению, созданному через запрос /createMessage или /createTargetedMessage. Хранится на стороне Wavesend в течение 5 минут.

users

Массив userIds. User ID — это уникальный идентификатор пользователя, устанавливаемый с помощью API-запроса /registerUser, /registerDevice или /registerEmail.