Messages

Example
{
  "request": {
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "applications_group": "GROUP_CODE", // optional. Can be used instead of "application".
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "notifications": [
      {
        // Content settings 
        "send_date": "now",  // required. YYYY-MM-DD HH:mm OR 'now'
        "ignore_user_timezone": true, // or false, required
        "timezone": "America/New_York", // optional. If ignored UTC-0 is default for "send_date". See http://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
            },
        "content": {  // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
          "en": "English",
          "ru": "Русский",
          "de": "Deutsch"
        },
        "title": { // optional, object( language1: 'title1', language2: 'title2' ) OR string. Ignored if platform-specific titles are specified (e.g., 'ios_title', 'android-header', etc.; see the platform-specific parameters examples below). 
          "en": "Title",
          "ru": "Заголовок"
        },
        "page_id": 39,  // optional, integer. HTML Page ID.
        "rich_media": "XXXXX-XXXXX", // optional, string. Copy the Rich Media code from the URL bar of the Rich Media editor page in Pushwoosh Control Panel. 
        "remote_page": "http://myremoteurl.com", // optional, string. Remote Rich HTML Page URL. <scheme>://<authority>
        "link": "http://google.com", // optional, string. For deeplinks add "minimize_link":0
        "minimize_link": 0, // optional. 0 — do not minimize, 2 — bitly. Default = 2. Google URL shortener is disabled since March 30, 2019. Please note that shorteners have restrictions on a number of calls. 
        "data": {
          "key": "value" // optional, JSON string or JSON object, will be passed as "u" parameter in the payload (converted to JSON string).
        },
        "transactionId": "6e22a9af-84e4-46e6-af16-e457a4a6e7e5", // optional, string. Unique message identifier to prevent duplicating in case of network problems. Stored on the side of Pushwoosh for 1 day. 
        "platforms": [1,2,3,5,7,8,9,10,11,12,13,17], // optional. 1 — iOS; 2 — BB; 3 — Android; 5 — Windows Phone; 7 — OS X; 8 — Windows 8; 9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox; 13 - IE11; 17 - Huawei; ignored if "devices" < 10
        "preset": "Q1A2Z-6X8SW", // optional. Push Preset Code from your Control Panel.
        "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
        "use_template" : true, // optional. Default 'false'
        "template_bindings" : {
              "TemplatePlaceholder" : "Value"
        },
            
        // Frequency capping params
        "capping_days": 30, // Amount of days for frequency capping (max 30 days)
        "capping_count": 10, // 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.   
        
        // 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. 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. 
        "devices": [ // optional. Specify tokens or hwids to send targeted push 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.               
          "dec301908b9ba8df85e57a58e40f96f523f4c2068674f5fe2ba25cdc250a2a41"
        ],
        
        // user-centric push notifications
        "users": [ // optional. If set, message will only be delivered to the 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.
          "user_3078a"
        ],
​
        //filters and conditions
        "filter": "FILTER_NAME", // optional
        "dynamic_content_placeholders": { // optional. Placeholders for dynamic content instead of device tags.
          "firstname": "John",
          "lastname": "Doe"
        },
        "conditions": [TAG_CONDITION1, TAG_CONDITION2, ..., TAG_CONDITIONN], // optional. See the remark below.    
        "conditions_operator": "AND" // optional, logical operator for conditions arrays. Possible values: AND | OR. AND is default. 
      }
    ]
  }
}

Example
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
            // Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"ios_badges": 5, // optional, integer. 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 no sound upon receiving a push.
			"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, string. iOS8 category ID from Pushwoosh.
			"ios_root_params": { // optional. Root level parameters to the aps dictionary.
				"aps": {
					"content-available": "1",
					"mutable-content": 1 // required for iOS 10 Media attachments.
				},
				"data": <<User supplied data, max of 4KB>>
			},
			"apns_trim_content": 1, // optional. (0|1) Trims the exceeding content strings with ellipsis.
			"ios_trim_content": 1, // Deprecated, use "apns_trim_content" instead.
			"ios_attachment" : "YOUR_ATTACHMENT_MEDIA_URL", // optional. Insert media content in notification. 
			"ios_title": "Title", // optional. Adds Title for push notification.
			"ios_subtitle": "SubTitle", // optional. Adds sub-title for push notification.
			"ios_thread_id": "some thread id", // optional, string. 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_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. 
		}]
	}
}

Example
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"android_root_params": {
				"key": "value"
			}, // optional. Custom key-value object. Root level parameters for the android payload recipients.
			"android_sound": "soundfile", // optional. No file extension. If left empty, the device will produce no sound upon receiving a push.
			"android_header": "header", // optional. Android notification header.
			"android_icon": "icon.png",
			"android_custom_icon": "http://example.com/image.png", // optional. Full path URL to the image file.
			"android_banner": "http://example.com/banner.png", // optional. Full path URL to the image file.
			"android_badges": 5, // optional, integer. 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, // boolean. Android force-vibration for high-priority pushes.
			"android_led": "#rrggbb", // LED hex color, device will do its best approximation.
			"android_priority": -1, // 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", // or "high", optional. Enables notification’s delivery when the device is in the power saving mode. 
			"android_ibc": "#RRGGBB", // icon background color on Lollipop, #RRGGBB, #AARRGGBB, "red", "black", "yellow", etc.
			"android_silent": 1 // optional. 0 or 1, enable silent notificaiton (ignore sound and content). 
		}]
	}
}

Safari
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"safari_title": "Title", // obligatory. Title of the notification. 
			"safari_action": "Click here", // optional
			"safari_url_args": ["firstArgument", "secondArgument"], // obligatory, but the value may be empty
			"safari_ttl": 3600 // optional. Time to live parameter — the maximum lifespan of a message in seconds.  
		}]
	}
}
​
​

Chrome
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"chrome_title": "Title", // optional. You can specify the header of the message in this parameter.
			"chrome_icon": "icon_URL", // full path 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": {
				"key": "value"
			}, // optional. Set parameters specific to messages sent to Chrome.
			"chrome_button_text1": "1", // optional
			"chrome_button_url1": "button1_URL", // optional. Ignored if chrome_button_text1 is not set.
			"chrome_button_text2": "2", // optional
			"chrome_button_url2": "button2_url" // optional. Ignored if chrome_button_text2 is not set. 
		}]
	}
}

Firefox
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"firefox_title": "Title", // optional. You can specify message header here.
			"firefox_icon": "icon_URL", // full path URL to the icon or path to the file in extension resources. 
			"firefox_root_params": {
				"key": "value"
			} // optional. Set parameters specific to messages sent to Firefox.
		}]
	}
}

Amazon
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"adm_root_params": {
				"key": "value"
			}, // custom key-value object
			"adm_sound": "push.mp3",
			"adm_header": "Header",
			"adm_icon": "icon",
			"adm_custom_icon": "http://example.com/image.png",
			"adm_banner": "http://example.com/banner.png",
			"adm_ttl": 3600, // optional. Time to live parameter — the maximum message lifespan in seconds.
			"adm_priority": -1 // priority of the push in Amazon push drawer, valid values are -2, -1, 0, 1 and 2.
		}]
	}
}

Windows Phone
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"wp_type": "Tile", // Windows Phone notification type. 'Tile' or 'Toast'. Raw notifications are not supported. 'Tile' is default. 
			"wp_background": "/Resources/Red.jpg", // tile image
			"wp_backbackground": "/Resources/Green.jpg", // back tile image
			"wp_backtitle": "back title", // back tile title 
			"wp_backcontent": "back content", // back tile content
			"wp_count": 3 // optional, integer. Badge for Windows Phone notification.
		}]
	}
}

Mac OS X
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"mac_badges": 3,
			"mac_sound": "sound.caf",
			"mac_root_params": {
				"content-available": 1
			},
			"mac_ttl": 3600 // optional. Time to live parameter — maximum message lifespan in seconds.
		}]
	}
}

Windows
{
	"request": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"wns_content": { // Content (XML or raw) of notification encoded in MIME's base64 in form of Object( language1: 'content1', language2: 'content2' ) OR String
				"en": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9ImF2YWlsYWJsZSIvPg==",
				"de": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9Im5ld01lc3NhZ2UiLz4="
			},
			"wns_type": "Badge", // '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": {
		"application": "12345-67891", // Pushwoosh application code
		"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
		"notifications": [{
			// Content settings
			"send_date": "now", // required. YYYY-MM-DD HH:mm OR 'now'
			"content": { // required, object( language1: 'content1', language2: 'content2' ) OR string. Ignored for Windows 8, use "wns_content" instead. (Use \n for multiline text. Ex: "hello\nfriend")
				"en": "English",
				"de": "Deutsch"
			},
​
			"huawei_android_badges": true,  // boolean
      "huawei_android_silent": 0, // 0 or 1, enable silent notificaiton (ignore sound and content).
      "huawei_android_icon": "http://example.com/icon.png", 
      "huawei_android_led": "#FF0011", // LED hex color, device will do its best approximation.
      "huawei_android_vibration": 1, // boolean. Huawei force-vibration for high-priority pushes.
      "huawei_android_sound": "sound.wav", // optional. No file extension. If left empty, the device will produce no sound upon receiving a push.
      "huawei_android_sound_off": true,
      "huawei_android_custom_icon": "http://example.com/custom_icon.png", 
      "huawei_android_header": "Huawei Header", // string. Notification title. 
      "huawei_android_gcm_ttl": 2400, // integer. Time to live parameter - maximum message lifespan in seconds.
      "huawei_android_banner": "http://example.com/banner.png", // Full path URL to the image file.
      "huawei_android_root_params": { // Custom key-value object. Root level parameters for the Huawei payload recipients.
      	"key": "value"
			},
      "huawei_android_priority": 0, // 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.
      "huawei_android_ibc": "#0011AA", // icon background color on Lollipop, #RRGGBB, #AARRGGBB, "red", "black", "yellow", etc.
      "huawei_android_lockscreen": 1,
      "huawei_android_delivery_priority": "normal" // or "high", optional. Enables notification’s delivery when the device is in the power saving mode. 
		}]
	}
}