Messages API

{
  "request": {
    "application": "XXXXX-XXXXX",       // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",     // required. API access token from Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",               // optional. YYYY-MM-DD HH:mm OR 'now'
      "content": {                      // optional. object OR string.
        "en": "English",                //           Use "wns_content" instead for Windows.
        "fr": "French"
      },
      "title": {                        // optional. object OR string.
        "en": "Title",                  //           Ignored if platform-specific titles are specified
        "fr": "Titre"                   //           'ios_title', 'android_header', etc.
      },                                //           see the platform-specific parameters examples below.
      "subtitle":{                      // optional. object OR string.
        "en": "Subtitle",               //           Ignored if platform-specific titles are specified
        "fr": "Sous-titre"              //           'ios_subtitle', etc.
      },                                //           see the platform-specific parameters examples below.
      "ignore_user_timezone": true,     // optional.
      "timezone": "America/New_York",   // optional. If ignored UTC-0 is default for "send_date".
                                        //           See https://php.net/manual/timezones.php for
                                        //           supported timezones.
      "campaign": "CAMPAIGN_CODE",      // optional. Campaign code to which you want to
                                        //           assign this push message.
      "geozone": {                      // optional. Send to Geozone
        "lat": 22.22,
        "lng": 33.33,
        "range": 110
      },
      "rich_media": "XXXXX-XXXXX",      // optional. Copy the Rich Media code from the URL bar of
                                        //           the Rich Media editor page in Pushwoosh Control Panel.
      "link": "https://google.com",     // optional. For deeplinks add "minimize_link": 0
      "minimize_link": 0,               // optional. 0 — do not minimize, 2 — bitly. Default = 2.
                                        //           Please note that shorteners have restrictions
                                        //           on a number of calls.
      "data": {                         // optional. JSON string or JSON object, will be passed as
        "key": "value"                  //           "u" parameter in the payload (converted to JSON string).
      },
      "transactionId": "unique UUID",   // optional. Unique message identifier to prevent duplicating
                                        //           in case of network problems. Stored on the side of
                                        //           Pushwoosh for 5 minutes.
      "platforms": [                    // optional. 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",          // optional. Push Preset Code from your Control Panel.
                                        //           If specific params are sent in the request,
                                        //           they override preset's params.
      "send_rate": 100,                 // optional. Throttling. Valid values are from 100 to 1000 pushes/second.

      // Templating related, please refer to the Template Engine guide to learn more
      "template_bindings": {            // optional.
        "TemplatePlaceholder": "Value"
      },
      "dynamic_content_placeholders": { // optional. Placeholders for dynamic content instead of device tags.
        "firstname": "John",
        "lastname": "Doe"
      },

      // Frequency capping params. Ensure that Global frequency capping is configured in the Control Panel.
      "capping_days": 30,               // optional. Amount of days for frequency capping (max 30 days)
      "capping_count": 10,              // optional. The max number of pushes that can be sent from a
                                        //           specific app to a particular device within a 'capping_days'
                                        //           period. In case the message created exceeds the
                                        //           'capping_count' limit for a device, it won't
                                        //           be sent to that device.
      "capping_exclude": true,          // optional. If set to true, this push notification will not
                                        //           be counted towards the capping for future pushes.
      "capping_avoid": true,            // optional. If set to true, capping will not be applied to
                                        //           this specific push notification.

      // To save the message to the Inbox via API, use "inbox_date" or "inbox_image".
      // The message is saved when at least one of these parameters is used.
      "inbox_date": "2017-02-02",       // optional. Specify when to remove a message from the Inbox.
                                        //           Message will be removed from Inbox at 00:00:01 UTC
                                        //           of the date specified, so the previous date is the
                                        //           last day a user can see the message in their Inbox.
                                        //           If not specified, the default removal date is the
                                        //           next day after the send date.
      "inbox_image": "Inbox image URL", // optional. The image to be shown near the message.
    "inbox_days": 5,                  // optional. Specify when to remove a message from the
                                        //           Inbox(lifetime of an inbox message in days).
                                        //           Can be used instead of the "inbox_date" parameter.
                                        //           Up to 30 days.

      "devices": [                      // optional. Specify tokens or hwids to send targeted push
          "hwid_XXXX"                   //           notifications. Not more than 1000 tokens/hwids in
      ],                                //           an array. If set, the message will only be sent to
                                        //           the devices on the list. Application Group for devices
                                        //           list is not allowed. iOS push tokens can only be lower case.

      // User-centric push notifications
      "users": [                        // optional. If set, message will only be delivered to the
          "user_XXXX"                   //           specified user ID's (set via /registerUser call).
      ],                                //           If specified together with devices parameter,
                                        //           the latter will be ignored. Not more than 1000 user
                                        //           ID's in an array. Application Group for users list
                                        //           is not allowed.

      // Filters and conditions
      "filter": "FILTER_NAME",          // optional.
      "conditions": [                   // optional. See the remark below.
        "Country", "EQ", "France",
        "Language", "EQ", "en"
      ],
      "conditions_operator": "AND"      // optional. Logical operator for conditions arrays.
                                        //           Possible values: AND | OR. AND is default.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",         // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",       // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "ios_title": {                      // optional. Object OR string. Adds iOS specific title for push notification.
        "en": "title"
      },
      "ios_subtitle": {                   // optional. Object OR string. Adds iOS specific subtitle for push notification.
        "en": "subtitle"
      },
      "ios_content": {                    // optional. Object OR string. Adds iOS specific content for push notification.
        "en": "content"
      },
      "ios_badges": 5,                    // optional. iOS application badge number.
                                          //           Use "+n" or "-n" to increment/decrement the badge value by n.
      "ios_sound": "sound file.wav",      // optional. Sound file name in the main bundle of application.
                                          //           If left empty, the device will produce a default system sound.
      "ios_sound_off": true,              // optional. Enable/disable sound set by "ios_sound" field.
      "ios_ttl": 3600,                    // optional. Time to live parameter - maximum message lifespan in seconds.
      "ios_silent": 1,                    // optional. Enables silent notifications (ignore "sound" and "content").
      "ios_category_id": "1",             // optional. iOS8 category ID from Pushwoosh.
      "ios_root_params": {                // optional. Root level parameters to the aps dictionary.
        "aps": {
          "content-available": "0",       // optional. Set "1" to send a silent push and "0" for regular push.
          "mutable-content": 1            // required for iOS10+ Media attachments.
        },
        "data": {}                        // optional. User supplied data, max of 4KB
      },
      "ios_attachment": "URL",            // optional. Insert media content in notification.
      "ios_thread_id": "some thread id",  // optional. Identifier to group related notifications.
                                          //           Messages with the same thread ID will be grouped
                                          //           on the lock screen and in the Notification Center.
      "ios_critical": true,               // optional. Marks iOS notification as a critical alert
                                          //           playing sound even if a device is muted or
                                          //           Do Not Disturb mode is on.
      "ios_category_custom": "category",  // optional. Custom APNS category.
      "ios_interruption_level": "active", // optional. One of "passive", "active", "time-sensitive",
                                          //           "critical". Indicates the importance and
                                          //           delivery timing of a notification. Refer to the
                                          //           One-time push guide for details.
      "apns_trim_content": 1              // optional. (0|1) Trims the exceeding content strings with ellipsis.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",            // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",          // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "android_header": {                    // optional. Android notification header.
        "en": "header"
      },
      "android_content": {                   // optional. Android notification content.
        "en": "content"
      },
      "android_root_params": {               // optional. Custom key-value object.
        "key": "value",                      //           Root level parameters for the android payload recipients.
        "CancelID": 12345678                 // optional. Cancels the push notification with the
      },                                     //           specified Message ID (get the ID from the Message History)
      "android_sound": "soundfile",          // optional. No file extension. If left empty,
                                             //           the device will produce a default system sound.
      "android_sound_off": true,             // optional. Enable/disable sound set by "android_sound" field
      "android_icon": "icon.png",            // optional.
      "android_custom_icon": "URL.png",      // optional. Full URL to the image file.
      "android_banner": "URL.png",           // optional. Full URL to the image file.
      "android_badges": 5,                   // optional. Android application icon badge number.
                                             //           Use "+n" or "-n" to increment/decrement the badge value by n.
      "android_gcm_ttl": 3600,               // optional. Time to live parameter — maximum message lifespan in seconds.
      "android_vibration": 0,                // optional. Android force-vibration for high-priority pushes.
      "android_led": "#rrggbb",              // optional. LED hex color, device will do its best approximation.
      "android_priority": -1,                // optional. Sets the "importance" parameter for devices with
                                             //           Android 8.0 and higher, as well as the "priority" parameter
                                             //           for devices with Android 7.1 and lower. Establishes the
                                             //           interruption level of a notification channel or a particular
                                             //           notification. Valid values are -2, -1, 0, 1, 2.
      "android_delivery_priority": "normal", // optional. "normal" or "high".
                                             //           Enables notification’s delivery when the
                                             //           device is in the power saving mode.
      "android_ibc": "#RRGGBB",              // optional. icon background color on Lollipop, #RRGGBB,
                                             //           #AARRGGBB, "red", "black", "yellow", etc.
      "android_silent": 1,                   // optional. 0 or 1. Enable silent notification.
                                             //           Ignore sound and content
      "android_group_id": "123"              // optional. Identifier to group related notifications. Messages with
                                             //           the same thread ID will be grouped in
                                             //           the Notification Center.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",                   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",                 // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "huawei_android_header": {                    // optional. Object OR string. Notification title
        "en": "header"
      },
      "huawei_android_content": {                   // optional. Object OR string. Notification content
        "en": "content"
      },
      "huawei_android_badges": true,                // optional.
      "huawei_android_silent": 0,                   // optional. 0 or 1. Enable silent notification.
                                                    //           Ignore sound and content
      "huawei_android_icon": "URL.png",             // optional.
      "huawei_android_led": "#FF0011",              // optional. LED hex color, device will do its best approximation
      "huawei_android_vibration": 1,                // optional. Huawei force-vibration for high-priority pushes
      "huawei_android_sound": "sound.wav",          // optional. If left empty, the device will produce
                                                    //           a default system sound
      "huawei_android_sound_off": true,             // optional. Enable/disable sound set by
                                                    //           "huawei_android_sound" field
      "huawei_android_custom_icon": "URL.png",      // optional
      "huawei_android_gcm_ttl": 2400,               // optional. Time to live parameter - maximum
                                                    //           message lifespan in seconds
      "huawei_android_banner": "URL.png",           // optional. Full path URL to the image file
      "huawei_android_root_params": {               // optional. Custom key-value object.
        "key": "value"                              //           Root-level parameters for Huawei payload recipients.
      },
      "huawei_android_priority": 0,                 // optional. Valid values: -2, -1, 0, 1, 2
      "huawei_android_ibc": "#0011AA",              // optional. Icon background color on Lollipop
      "huawei_android_lockscreen": 1,               // optional
      "huawei_android_delivery_priority": "normal", // optional. "normal" or "high". Enables notification
                                                    //           delivery in power saving mode
      "huawei_android_group_id": "group_id"         // optional. Identifier to group related notifications
    }]
  }
}

{
  "request": {
    "application": "12345-67891",    // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "safari_url_args": [           // required, but the value may be empty
        "firstArgument",
        "secondArgument"
      ],
      "safari_title": {              // optional. Object OR string. Title of the notification.
        "en": "content"
      },
      "safari_content": {            // optional. Object OR string. Content of the notification.
        "en": "content"
      },
      "safari_action": "Click here", // optional.
      "safari_ttl": 3600             // optional. Time to live parameter — the maximum
                                     //           lifespan of a message in seconds.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",          // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",        // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "chrome_title": {                    // optional. Object OR string. You can specify the header
        "en": "title"                      //           of the message in this parameter.
      },
      "chrome_content": {                  // optional. Object OR string. You can specify the content
        "en": "content"                    //           of the message in this parameter.
      },
      "chrome_icon": "URL.png",            // optional. Full URL to the icon or extension resources file path
      "chrome_gcm_ttl": 3600,              // optional. Time to live parameter – maximum message lifespan in seconds.
      "chrome_duration": 20,               // optional. max 50 seconds. Changes chrome push display time.
                                           //           Set to 0 to display push until user interacts with it.
      "chrome_image": "image_URL",         // optional. URL to large image.
      "chrome_root_params": {              // optional. Set parameters specific to messages sent to Chrome.
        "key": "value"
      },
      "chrome_button_text1": "text1",      // optional
      "chrome_button_url1": "button1_URL", // optional. Ignored if chrome_button_text1 is not set.
      "chrome_button_text2": "text2",      // optional
      "chrome_button_url2": "button2_url"  // optional. Ignored if chrome_button_text2 is not set.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "firefox_title": {            // optional. Object OR string. You can specify message header here.
        "en": "title"
      },
      "firefox_content": {          // optional. Object OR string. You can specify message content here.
        "en": "content"
      },
      "firefox_icon": "URL.png",    // optional. Full path URL to the icon or path to the
                                    //           file in extension resources.
      "firefox_root_params": {      // optional. Set parameters specific to messages sent to Firefox.
        "key": "value"
      }
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "adm_header": {               // optional. Object OR string. You can specify message header here.
        "en": "header"
      },
      "adm_content": {              // optional. Object OR string. You can specify message content here.
        "en": "content"
      },
      "adm_root_params": {          // optional. Custom key-value object
        "key": "value"
      },
      "adm_sound": "push.mp3",      // optional.
      "adm_sound_off": true,        // optional. Enable/disable sound set by "adm_sound" field
      "adm_icon": "icon.png",       // optional. Full URL to the icon.
      "adm_custom_icon": "URL.png", // optional.
      "adm_banner": "URL.png",      // optional.
      "adm_ttl": 3600,              // optional. Time to live parameter — the maximum message
                                    //           lifespan in seconds.
      "adm_priority": -1            // optional. Priority of the push in Amazon push drawer,
                                    //           valid values are -2, -1, 0, 1 and 2.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "mac_title": {                // optional. Object OR string. Adds Title for push notification.
        "en": "title"
      },
      "mac_subtitle": {             // optional. Adds subtitle for push notification.
        "en": "subtitle"
      },
      "mac_content": {              // optional. Adds content for push notification.
        "en": "content"
      },
      "mac_badges": 3,              // optional.
      "mac_sound": "sound.caf",     // optional.
      "mac_sound_off": true,        // optional. Enable/disable sound set by "mac_sound" field
      "mac_root_params": {          // optional.
        "content-available": 1
      },
      "mac_ttl": 3600               // optional. Time to live parameter — maximum message lifespan in seconds.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "notifications": [{
      "wns_content": {              // required. Content (XML or raw) of notification encoded in MIME's base64
                                    //           in form of Object OR String
        "en": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9ImF2YWlsYWJsZSIvPg==",
        "de": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9Im5ld01lc3NhZ2UiLz4="
      },
      "wns_type": "Badge",          // optional. 'Tile' | 'Toast' | 'Badge' | 'Raw'
      "wns_tag": "myTag",           // optional. Used in Tile replacement policy.
                                    //           An alphanumeric string of no more than 16 characters.
      "wns_cache": 1,               // optional. (1|0) Translates into X-WNS-Cache-Policy value.
      "wns_ttl": 600                // optional. Expiration time for notification in seconds.
    }]
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "message": "xxxx-xxxxxxx-xxxxxx" // required. Message code obtained in /createMessage
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "message": "xxxx-xxxxxxx-xxxxxx" // required. message code or message ID
  }
}