Messages API

{
  "request": {
    "application": "XXXXX-XXXXX",       // обязательный. Код приложения Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",     // обязательный. Токен доступа к API из Панели управления Pushwoosh.
    "notifications": [{
      "send_date": "now",               // опционально. YYYY-MM-DD HH:mm ИЛИ 'now'
      "content": {                      // опционально. объект ИЛИ строка.
        "en": "English",                //           Для Windows используйте "wns_content".
        "fr": "French"
      },
      "title": {                        // опционально. объект ИЛИ строка.
        "en": "Title",                  //           Игнорируется, если указаны заголовки для конкретных платформ
        "fr": "Titre"                   //           'ios_title', 'android_header' и т. д.
      },                                //           см. примеры параметров для конкретных платформ ниже.
      "subtitle":{                      // опционально. объект ИЛИ строка.
        "en": "Subtitle",               //           Игнорируется, если указаны заголовки для конкретных платформ
        "fr": "Sous-titre"              //           'ios_subtitle' и т. д.
      },                                //           см. примеры параметров для конкретных платформ ниже.
      "ignore_user_timezone": true,     // опционально.
      "timezone": "America/New_York",   // опционально. Если не указано, для "send_date" по умолчанию используется UTC-0.
                                        //           См. https://php.net/manual/timezones.php для
                                        //           поддерживаемых часовых поясов.
      "campaign": "CAMPAIGN_CODE",      // опционально. Код кампании, к которой вы хотите
                                        //           привязать это push-уведомление.
      "geozone": {                      // опционально. Отправить в геозону
        "lat": 22.22,
        "lng": 33.33,
        "range": 110
      },
      "rich_media": "XXXXX-XXXXX",      // опционально. Скопируйте код Rich Media из адресной строки
                                        //           страницы редактора Rich Media в Панели управления Pushwoosh.
      "link": "https://google.com",     // опционально. Для диплинков добавьте "minimize_link": 0
      "minimize_link": 0,               // опционально. 0 — не сокращать, 2 — bitly. По умолчанию = 2.
                                        //           Обратите внимание, что у сервисов сокращения ссылок есть ограничения
                                        //           на количество вызовов.
      "data": {                         // опционально. Строка JSON или объект JSON, будет передан как
        "key": "value"                  //           параметр "u" в полезной нагрузке (преобразованный в строку JSON).
      },
      "transactionId": "unique UUID",   // опционально. Уникальный идентификатор сообщения для предотвращения дублирования
                                        //           в случае проблем с сетью. Хранится на стороне
                                        //           Pushwoosh в течение 5 минут.
      "platforms": [                    // опционально. 1 — iOS; 3 — Android; 7 — Mac OS X; 8 — Windows;
        1, 3, 7, 8, 9, 10,              //           9 — Amazon; 10 — Safari; 11 — Chrome;
        11, 12, 17                      //           12 — Firefox; 17 — Huawei
      ],
      "preset": "XXXXX-XXXXX",          // опционально. Код пресета для push-уведомлений из вашей Панели управления.
                                        //           Если в запросе передаются конкретные параметры,
                                        //           они переопределяют параметры пресета.
      "send_rate": 100,                 // опционально. Регулирование скорости. Допустимые значения от 100 до 1000 push-уведомлений/секунду.

      // Связано с шаблонами, пожалуйста, обратитесь к руководству по движку шаблонов, чтобы узнать больше
      "template_bindings": {            // опционально.
        "TemplatePlaceholder": "Value"
      },
      "dynamic_content_placeholders": { // опционально. Плейсхолдеры для динамического контента вместо тегов устройства.
        "firstname": "John",
        "lastname": "Doe"
      },

      // Параметры ограничения частоты. Убедитесь, что глобальное ограничение частоты настроено в Панели управления.
      "capping_days": 30,               // опционально. Количество дней для ограничения частоты (макс. 30 дней)
      "capping_count": 10,              // опционально. Максимальное количество push-уведомлений, которое может быть отправлено из
                                        //           конкретного приложения на конкретное устройство в течение периода 'capping_days'.
                                        //           Если созданное сообщение превышает лимит
                                        //           'capping_count' для устройства, оно не
                                        //           будет отправлено на это устройство.
      "capping_exclude": true,          // опционально. Если установлено значение true, это push-уведомление не
                                        //           будет учитываться при ограничении частоты для будущих push-уведомлений.
      "capping_avoid": true,            // опционально. Если установлено значение true, ограничение частоты не будет применяться к
                                        //           этому конкретному push-уведомлению.

      // Чтобы сохранить сообщение в Inbox через API, используйте "inbox_date" или "inbox_image".
      // Сообщение сохраняется при использовании хотя бы одного из этих параметров.
      "inbox_date": "2017-02-02",       // опционально. Укажите, когда удалить сообщение из Inbox.
                                        //           Сообщение будет удалено из Inbox в 00:00:01 UTC
                                        //           указанной даты, поэтому предыдущая дата является
                                        //           последним днем, когда пользователь может видеть сообщение в своем Inbox.
                                        //           Если не указано, датой удаления по умолчанию является
                                        //           следующий день после даты отправки.
      "inbox_image": "Inbox image URL", // опционально. Изображение, которое будет показано рядом с сообщением.
    "inbox_days": 5,                  // опционально. Укажите, когда удалить сообщение из
                                        //           Inbox (срок жизни сообщения в Inbox в днях).
                                        //           Может использоваться вместо параметра "inbox_date".
                                        //           До 30 дней.

      "devices": [                      // опционально. Укажите токены или HWID для отправки целевых push-
          "hwid_XXXX"                   //           уведомлений. Не более 1000 токенов/HWID в
      ],                                //           массиве. Если установлено, сообщение будет отправлено только на
                                        //           устройства из списка. Группа приложений для списка
                                        //           устройств не допускается. Push-токены iOS могут быть только в нижнем регистре.

      // Push-уведомления, ориентированные на пользователя
      "users": [                        // опционально. Если установлено, сообщение будет доставлено только
          "user_XXXX"                   //           указанным ID пользователей (устанавливаются через вызов /registerUser).
      ],                                //           Если указан вместе с параметром devices,
                                        //           последний будет проигнорирован. Не более 1000
                                        //           ID пользователей в массиве. Группа приложений для списка пользователей
                                        //           не допускается.

      // Фильтры и условия
      "filter": "FILTER_NAME",          // опционально.
      "conditions": [                   // опционально. См. примечание ниже.
        "Country", "EQ", "France",
        "Language", "EQ", "en"
      ],
      "conditions_operator": "AND"      // опционально. Логический оператор для массивов условий.
                                        //           Возможные значения: AND | OR. По умолчанию AND.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",         // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",       // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "ios_title": {                      // опционально. Объект ИЛИ строка. Добавляет заголовок для push-уведомления на iOS.
        "en": "title"
      },
      "ios_subtitle": {                   // опционально. Объект ИЛИ строка. Добавляет подзаголовок для push-уведомления на iOS.
        "en": "subtitle"
      },
      "ios_content": {                    // опционально. Объект ИЛИ строка. Добавляет контент для push-уведомления на iOS.
        "en": "content"
      },
      "ios_badges": 5,                    // опционально. Число на иконке приложения iOS.
                                          //           Используйте "+n" или "-n", чтобы увеличить/уменьшить значение на n.
      "ios_sound": "sound file.wav",      // опционально. Имя звукового файла в основном бандле приложения.
                                          //           Если оставить пустым, устройство воспроизведет системный звук по умолчанию.
      "ios_sound_off": true,              // опционально. Включить/выключить звук, установленный полем "ios_sound".
      "ios_ttl": 3600,                    // опционально. Параметр времени жизни - максимальное время жизни сообщения в секундах.
      "ios_silent": 1,                    // опционально. Включает тихие уведомления (игнорирует "sound" и "content").
      "ios_category_id": "1",             // опционально. ID категории iOS 8 из Pushwoosh.
      "ios_root_params": {                // опционально. Параметры корневого уровня для словаря aps.
        "aps": {
          "content-available": "0",       // опционально. Установите "1" для отправки тихого push-уведомления и "0" для обычного.
          "mutable-content": 1            // обязательно для медиа-вложений в iOS 10+.
        },
        "data": {}                        // опционально. Пользовательские данные, макс. 4 КБ
      },
      "ios_attachment": "URL",            // опционально. Вставить медиа-контент в уведомление.
      "ios_thread_id": "some thread id",  // опционально. Идентификатор для группировки связанных уведомлений.
                                          //           Сообщения с одинаковым ID потока будут сгруппированы
                                          //           на экране блокировки и в Центре уведомлений.
      "ios_critical": true,               // опционально. Помечает уведомление iOS как критическое оповещение,
                                          //           которое воспроизводит звук, даже если на устройстве выключен звук или
                                          //           включен режим "Не беспокоить".
      "ios_category_custom": "category",  // опционально. Пользовательская категория APNS.
      "ios_interruption_level": "active", // опционально. Одно из "passive", "active", "time-sensitive",
                                          //           "critical". Указывает на важность и
                                          //           время доставки уведомления. Подробности см. в
                                          //           руководстве по одноразовым push-уведомлениям.
      "apns_trim_content": 1              // опционально. (0|1) Обрезает слишком длинные строки контента многоточием.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",            // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",          // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "android_header": {                    // опционально. Заголовок уведомления Android.
        "en": "header"
      },
      "android_content": {                   // опционально. Контент уведомления Android.
        "en": "content"
      },
      "android_root_params": {               // опционально. Пользовательский объект ключ-значение.
        "key": "value",                      //           Параметры корневого уровня для получателей полезной нагрузки Android.
        "CancelID": 12345678                 // опционально. Отменяет push-уведомление с
      },                                     //           указанным ID сообщения (получите ID из Истории сообщений)
      "android_sound": "soundfile",          // опционально. Без расширения файла. Если оставить пустым,
                                             //           устройство воспроизведет системный звук по умолчанию.
      "android_sound_off": true,             // опционально. Включить/выключить звук, установленный полем "android_sound".
      "android_icon": "icon.png",            // опционально.
      "android_custom_icon": "URL.png",      // опционально. Полный URL-адрес файла изображения.
      "android_banner": "URL.png",           // опционально. Полный URL-адрес файла изображения.
      "android_badges": 5,                   // опционально. Число на иконке приложения Android.
                                             //           Используйте "+n" или "-n", чтобы увеличить/уменьшить значение на n.
      "android_gcm_ttl": 3600,               // опционально. Параметр времени жизни — максимальное время жизни сообщения в секундах.
      "android_vibration": 0,                // опционально. Принудительная вибрация Android для высокоприоритетных push-уведомлений.
      "android_led": "#rrggbb",              // опционально. HEX-код цвета светодиода, устройство постарается подобрать наиболее близкий цвет.
      "android_priority": -1,                // опционально. Устанавливает параметр "importance" для устройств с
                                             //           Android 8.0 и выше, а также параметр "priority"
                                             //           для устройств с Android 7.1 и ниже. Устанавливает
                                             //           уровень прерывания для канала уведомлений или конкретного
                                             //           уведомления. Допустимые значения: -2, -1, 0, 1, 2.
      "android_delivery_priority": "normal", // опционально. "normal" или "high".
                                             //           Включает доставку уведомлений, когда
                                             //           устройство находится в режиме энергосбережения.
      "android_ibc": "#RRGGBB",              // опционально. цвет фона иконки на Lollipop, #RRGGBB,
                                             //           #AARRGGBB, "red", "black", "yellow" и т. д.
      "android_silent": 1,                   // опционально. 0 или 1. Включить тихое уведомление.
                                             //           Игнорировать звук и контент
      "android_group_id": "123"              // опционально. Идентификатор для группировки связанных уведомлений. Сообщения с
                                             //           одинаковым ID потока будут сгруппированы в
                                             //           Центре уведомлений.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",                   // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",                 // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "huawei_android_header": {                    // опционально. Объект ИЛИ строка. Заголовок уведомления
        "en": "header"
      },
      "huawei_android_content": {                   // опционально. Объект ИЛИ строка. Контент уведомления
        "en": "content"
      },
      "huawei_android_badges": true,                // опционально.
      "huawei_android_silent": 0,                   // опционально. 0 или 1. Включить тихое уведомление.
                                                    //           Игнорировать звук и контент
      "huawei_android_icon": "URL.png",             // опционально.
      "huawei_android_led": "#FF0011",              // опционально. HEX-код цвета светодиода, устройство постарается подобрать наиболее близкий цвет
      "huawei_android_vibration": 1,                // опционально. Принудительная вибрация Huawei для высокоприоритетных push-уведомлений
      "huawei_android_sound": "sound.wav",          // опционально. Если оставить пустым, устройство воспроизведет
                                                    //           системный звук по умолчанию
      "huawei_android_sound_off": true,             // опционально. Включить/выключить звук, установленный
                                                    //           полем "huawei_android_sound"
      "huawei_android_custom_icon": "URL.png",      // опционально
      "huawei_android_gcm_ttl": 2400,               // опционально. Параметр времени жизни - максимальное
                                                    //           время жизни сообщения в секундах
      "huawei_android_banner": "URL.png",           // опционально. Полный URL-адрес файла изображения
      "huawei_android_root_params": {               // опционально. Пользовательский объект ключ-значение.
        "key": "value"                              //           Параметры корневого уровня для получателей полезной нагрузки Huawei.
      },
      "huawei_android_priority": 0,                 // опционально. Допустимые значения: -2, -1, 0, 1, 2
      "huawei_android_ibc": "#0011AA",              // опционально. Цвет фона иконки на Lollipop
      "huawei_android_lockscreen": 1,               // опционально
      "huawei_android_delivery_priority": "normal", // опционально. "normal" или "high". Включает доставку
                                                    //           уведомлений в режиме энергосбережения
      "huawei_android_group_id": "group_id"         // опционально. Идентификатор для группировки связанных уведомлений
    }]
  }
}

{
  "request": {
    "application": "12345-67891",    // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "safari_url_args": [           // обязательно, но значение может быть пустым
        "firstArgument",
        "secondArgument"
      ],
      "safari_title": {              // опционально. Объект ИЛИ строка. Заголовок уведомления.
        "en": "content"
      },
      "safari_content": {            // опционально. Объект ИЛИ строка. Контент уведомления.
        "en": "content"
      },
      "safari_action": "Click here", // опционально.
      "safari_ttl": 3600             // опционально. Параметр времени жизни — максимальное
                                     //           время жизни сообщения в секундах.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",          // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",        // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "chrome_title": {                    // опционально. Объект ИЛИ строка. Вы можете указать заголовок
        "en": "title"                      //           сообщения в этом параметре.
      },
      "chrome_content": {                  // опционально. Объект ИЛИ строка. Вы можете указать контент
        "en": "content"                    //           сообщения в этом параметре.
      },
      "chrome_icon": "URL.png",            // опционально. Полный URL-адрес иконки или путь к файлу в ресурсах расширения
      "chrome_gcm_ttl": 3600,              // опционально. Параметр времени жизни – максимальное время жизни сообщения в секундах.
      "chrome_duration": 20,               // опционально. макс. 50 секунд. Изменяет время отображения push-уведомления в Chrome.
                                           //           Установите 0 для отображения push-уведомления до тех пор, пока пользователь не взаимодействует с ним.
      "chrome_image": "image_URL",         // опционально. URL-адрес большого изображения.
      "chrome_root_params": {              // опционально. Установите параметры, специфичные для сообщений, отправляемых в Chrome.
        "key": "value"
      },
      "chrome_button_text1": "text1",      // опционально
      "chrome_button_url1": "button1_URL", // опционально. Игнорируется, если chrome_button_text1 не установлен.
      "chrome_button_text2": "text2",      // опционально
      "chrome_button_url2": "button2_url"  // опционально. Игнорируется, если chrome_button_text2 не установлен.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "firefox_title": {            // опционально. Объект ИЛИ строка. Здесь вы можете указать заголовок сообщения.
        "en": "title"
      },
      "firefox_content": {          // опционально. Объект ИЛИ строка. Здесь вы можете указать контент сообщения.
        "en": "content"
      },
      "firefox_icon": "URL.png",    // опционально. Полный URL-адрес иконки или путь к
                                    //           файлу в ресурсах расширения.
      "firefox_root_params": {      // опционально. Установите параметры, специфичные для сообщений, отправляемых в Firefox.
        "key": "value"
      }
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "adm_header": {               // опционально. Объект ИЛИ строка. Здесь вы можете указать заголовок сообщения.
        "en": "header"
      },
      "adm_content": {              // опционально. Объект ИЛИ строка. Здесь вы можете указать контент сообщения.
        "en": "content"
      },
      "adm_root_params": {          // опционально. Пользовательский объект ключ-значение
        "key": "value"
      },
      "adm_sound": "push.mp3",      // опционально.
      "adm_sound_off": true,        // опционально. Включить/выключить звук, установленный полем "adm_sound".
      "adm_icon": "icon.png",       // опционально. Полный URL-адрес иконки.
      "adm_custom_icon": "URL.png", // опционально.
      "adm_banner": "URL.png",      // опционально.
      "adm_ttl": 3600,              // опционально. Параметр времени жизни — максимальное время
                                    //           жизни сообщения в секундах.
      "adm_priority": -1            // опционально. Приоритет push-уведомления в панели push-уведомлений Amazon,
                                    //           допустимые значения: -2, -1, 0, 1 и 2.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "mac_title": {                // опционально. Объект ИЛИ строка. Добавляет заголовок для push-уведомления.
        "en": "title"
      },
      "mac_subtitle": {             // опционально. Добавляет подзаголовок для push-уведомления.
        "en": "subtitle"
      },
      "mac_content": {              // опционально. Добавляет контент для push-уведомления.
        "en": "content"
      },
      "mac_badges": 3,              // опционально.
      "mac_sound": "sound.caf",     // опционально.
      "mac_sound_off": true,        // опционально. Включить/выключить звук, установленный полем "mac_sound".
      "mac_root_params": {          // опционально.
        "content-available": 1
      },
      "mac_ttl": 3600               // опционально. Параметр времени жизни — максимальное время жизни сообщения в секундах.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // обязательный. Код приложения Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "notifications": [{
      "wns_content": {              // обязательно. Содержимое (XML или raw) уведомления, закодированное в base64 (MIME)
                                    //           в виде объекта ИЛИ строки
        "en": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9ImF2YWlsYWJsZSIvPg==",
        "de": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9Im5ld01lc3NhZ2UiLz4="
      },
      "wns_type": "Badge",          // опционально. 'Tile' | 'Toast' | 'Badge' | 'Raw'
      "wns_tag": "myTag",           // опционально. Используется в политике замены плиток.
                                    //           Буквенно-цифровая строка длиной не более 16 символов.
      "wns_cache": 1,               // опционально. (1|0) Транслируется в значение X-WNS-Cache-Policy.
      "wns_ttl": 600                // опционально. Время истечения срока действия уведомления в секундах.
    }]
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "message": "xxxx-xxxxxxx-xxxxxx" // обязательный. Код сообщения, полученный в /createMessage
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательный. Токен доступа к API из Панели управления Pushwoosh
    "message": "xxxx-xxxxxxx-xxxxxx" // обязательный. код сообщения или ID сообщения
  }
}