Push Notification
Android Push
This function allows you to send a push notification using Google Cloud Messages inside your flows.
Section | Parameters | Usage | Mandatory |
---|---|---|---|
Configuration | GCM Server API Key | This is the API Key that allows you to send notifications to your applications. Your GCM Sender ID helps authenticate against CleverTap, allowing us to send push notifications on your behalf. | No |
Device Token | This is the device identifier that is going to receive the notification from us. | No | |
Notification | Ticker Text | This is an small ticker text in your notification. | No |
Title | The title of the notification. | No | |
Message | The text that will be sent to the user. Max 140 characters. | No |
Response parameters
Parameter | Content |
---|---|
multicast_id | Identifies the multicast message. |
success | Number of messages that were processed without an error. |
failure | Number of messages that could not be processed. |
canonical_ids | Number of messages that were processed without an error. |
results | Array of objects representing the status of the messages processed. The objects are listed in the same order as the request (i.e., for each registration ID in the request, its result is listed in the same index in the response). |
results.registration_id | This parameter specifies the canonical registration token for the client app that the message was processed and sent to. Sender should replace the registration token with this value on future requests; otherwise, the messages might be rejected. |
results.message_id | The topic message ID when GCM has successfully received the request and will attempt to deliver to all subscribed devices. |
log | This contains the procedure log. |
message | This is the output message. |
error | This will contain an error message if the process fails. |
iOS Push
This function allows you to send a push notification using Apple Push Notification Services inside your flows.
Section | Parameters | Usage | Mandatory |
---|---|---|---|
Configuration | App Passphrase | This parameter allows users to password protect the certificates. | No |
Apple Certificate Authority File | This is your path to the Root Certificate authority file in Flowize. | No | |
Apple Private Certificate File | This is your path to the Private Certificate file in Flowize. It should be a .pem or .p12 file | No | |
Device Token | This is the device identifier that is going to receive the notification from us. | No | |
Server | This is the server that you want to send Push Notifications (Sandbox | Production). | No | |
Application name | This parameter allows users to identify the application in a log response. | No | |
Custom property | In this field you can include a custom property that you need for you application.You will receive it in your App in the “customProperty” attribute. | No | |
Sound | Indicates a sound to play when the device receives a notification. If the field is empty then it will apply default sound. i.e: music.aiff. | No | |
Badge | The number to display as the badge of the application icon. If this property is absent, the badge is not changed. To remove the badge, set the value of this property to 0. | No | |
Time to live | This parameter specifies how long (in seconds) the message should be kept in your app if the device is offline. By default, this value is 10. | No | |
Notification | Title | The title of the notification. | No |
Message | The text that will be sent to the user. Max 140 characters. | No |
Response parameters
Parameter | Content |
---|---|
log | This contains the procedure log. |
message | This is the output message. |
error | This will contain an error message if the process fails. |
Windows Push
This function allows you to send a push notification using Windows Push Notification Services inside your flows.
Section | Parameters | Usage | Mandatory |
---|---|---|---|
Configuration | Device Token | This is the WINDOWS device identifier that is going to receive the notification from us. | No |
Notification | Title | The title of the notification. | No |
Message | The text that will be sent to the user. Max 140 characters. | No |
Response parameters
Parameter | Content |
---|---|
X-SubscriptionStatus | The subscription status. |
X-NotificationStatus | The notification status. |
X-DeviceConnectionStatus | The device connection status. |
log | This contains the procedure log. |
message | This is the output message. |
error | This will contain an error message if the process fails. |