sendNotification (service) [v1]
This command is deprecated! Use sendNotification (service) [v2] instead!
API version: 1
Availability: DIGIPASS Gateway 4.1 and later
Authentication: Basic HTTP authentication using the front-end API key.
The sendNotification service sends a push notification message to a user.
URL
https://dpgateway_host:dpgateway_port/rest/notification/sendNotification
Request
sendNotification parameters
Parameter name |
Data type |
Description |
app_id
|
String |
Optional. Required if pushing to iOS devices.The application identifier. |
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"
}