Параметры /createMessage

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

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

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

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

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

Токен доступа к API из Панели управления Pushwoosh. Перейдите в Settings → API Access и скопируйте токен, который хотите использовать, или сгенерируйте новый.

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

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

"content": "Hello world!",

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

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

Массив 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

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

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

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

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

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

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

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

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

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

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

Допустимые операторы: 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: тег не установлен. Операнд не учитывается;
• ANY: тег имеет любое значение. Операнд не учитывается.

Допустимые операторы: 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"].

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

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

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

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

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

Плейсхолдеры для Динамического контента, которые будут использоваться вместо значений Тегов устройства. Приведенный ниже пример отправит сообщение “Hello, John!” каждому пользователю, на которого вы нацелены. Если параметр не установлен, значения Динамического контента берутся из Тегов устройства.

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

Название Сегмента (Segment) в точности так, как оно создано в Панели управления Pushwoosh или через API-запрос /createFilter. Перейдите в раздел Audience → Segments (Filters) и проверьте список созданных Сегментов.

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

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

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

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

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

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

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

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

Массив кодов платформ для отправки сообщения только на определенные платформы. Список доступных платформ: Доступные коды платформ включают: 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), созданного в Панели управления Pushwoosh или через API. Чтобы получить код пресета, перейдите в Content → Presets, разверните пресет, который собираетесь использовать, и скопируйте Preset Code из его деталей.

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

Ограничение (throttling) для сдерживания скорости отправки push-уведомлений. Допустимые значения от 100 до 1000 push-уведомлений в секунду.

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

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

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

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