API version: 2
Availability: DIGIPASS Gateway 5.0 and later
Authentication: The service is secured by the back-end and front-end API key.
The sendNotification service sends a push notification message to a user.
URL
https://dpgateway_host:dpgateway_port/rest/v2/notification/push /sendNotification
Request
sendNotification parameters | ||
Parameter name | Data type | Description |
|---|---|---|
app_id | String | Optional. Required if pushing to iOS devices. The application identifier. |
isHighPriority | Boolean | Optional. Determines whether the notification should be treated with high priority. For instance, high priority notifications can be received without delay and wake up the screen, even if the target device is in Do Not Disturb or a sleep mode. Default value: True Availability. DIGIPASS Gateway 5.9 or later |
message | String | Required. The text to be used as content of the notification message. |
pnid | String | Required. The push notification identifier of the authenticator to send the notification message to. |
subject | String | Optional. The text to be used as subject of the notification message. |
title | String | Optional. The text to be used as title of the notification message. |
Parameter names are case-sensitive.
Example
{
"pnid": "01000001010200CC4150413931624841694341666A4854385755586C7751...",
"app_id": "com.example.someapp",
"subject": "Notification subject",
"title": "Notification title",
"message": "Notification message"
}Response
sendNotification return values | ||
Return value | Data type | Description |
|---|---|---|
error_message | String | An error message in case of an error, e.g. when an invalid request is received. |
device_platform | String | The platform of the device that has actually received the notification message. |
Example
{
"device_platform": "ANDROID"
}