Push Notifications API
Jan 1 2022 at 12:00 AM
A push notification is a message that pops up on a mobile device. The Push notification service is used to send push notifications to registered devices. The source of the message can either be a trigger within the system or be created from any of the services within the stack.
Prerequisites
To use this service you will first need to create a user in portal and register the user to receive push notifications (Via mobile app).
APIs within Push Notifications API
PushNotification
API Calls
RegisterDevice
Permission
DapiContext Current Username
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/PushNotification/RegisterDevice
URL Params
NONE
Data Params
{
“pushId”: “string”
}
- pushId: string (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
DeregisterDevice
Permission
NONE
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/PushNotification/DeregisterDevice
URL Params
NONE
Data Params
{
“pushId”: “string”
}
- pushId: string (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
Send
Permission
NONE
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/PushNotification/Send
URL Params
NONE
Data Params
{
“title”: “string”,
“message": “string”,
“userIds”: "{“string”, “string”}"
}
- title: string (required)
- message: string (required)
- userIds: string[] (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetLogs
Permission
push_notification:get_logs
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/PushNotification/GetLogs
URL Params
NONE
Data Params
{
"userId”: “string”,
“fromDateTime “: DateTime,
“toDateTime”: DateTime
}
- userId: string (required)
- fromDateTime : DateTime (required)
- toDateTime: DateTime (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None