Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
NotificationIntevalEnum
NotificationIntevalEnum

NotificationIntervalNotification Interval

The schedule notification interval

...

NameTypeDescription
IntervalNotificationInterval

Interval that determines the delay between each sending

EndDate

ISO formatted String, in UTC timezone, format

is yyyy-MM-ddTHH:mm:ssZ

optional, the end date of the schedule notification.

OccurrencesIntoptional, times the notification will be sent
StartDate

ISO formatted String, in UTC timezone, format

is yyyy-MM-ddTHH:mm:ssZ

optional (default is now), the time for the first notification
ConsiderDeviceTimeZoneBoolean

optional (default is false), sending the notification on the provided time according to the device's time zone.

...

NameTypeDescription
SecretToken String mandatoryThe token received from PushApps for using the Remote API
MessageString mandatoryThe content of the message
PlatformsArray of DeviceTypeoptionalThe platforms this notification will be sent to. If not set or empty the notification will be sent to all platforms
DevicesArray of Device

optional

If not supplied or empty, the notification will be sent to all available devices according to the selected platforms
DeviceIdsArray of Strings

optional

 

If supplied, message will be delivered to supplied deviceIds. 
Cannot be used along with CustomIds.
CustomIdsArray of Strings

optional

If supplied, message will be delivered to supplied CustomIds. 
Cannot be supplied with DeviceIds.
LinkStringoptionalIf exists the device will open a browser with the URL specified here
PlatformFeaturesPlatformFeaturesoptionalFeatures per platform. This parameter is optional and also each field inside it is optional. 
CustomJsonKeyStringoptionalThe key in the data object received in the push notification. If you supply a CustomJsonKey you must supply the CustomJson as well
CustomJsonStringoptionalThe value of the data object received in the push notification. can be either a JSON formatted string or a regular string. if you supplyCustomJson and don't supply a CustomJsonKey we will use our default key (D)
IdIntoptional

Add more devices to a specific notification by the notification id you receive from us.Use this If you need to send notifications to specific devices that are more than 10,000 devices. you will receive this id in your first request's response. afterwards call the request with more devices as many times as you need, always using the same Id.

SchedulingSchedulingFeaturesoptionalScheduling features allows you to plan further ahead your notifications by setting the send date to a specific day and adding number of occurrences.

...