Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Notifications
GET /notifications/{organizationId}
Description
Retrieve all notifications for an organization.
Return type
collection of notifications
Parameters
| Name | Data Type | Requried? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the notifications. |
notificationEventId | long | y | Restrict returned notifications to a specific notificationEvent. |
onlyActive | boolean | y | Boolean value indicating whether only active broadcasts should be returned. Default = false |
pageNumber | int | y | The page number of notifications to return. |
GET /notifications/{organizationId}/{notificationId}
Description
Retrieve the status of a notification within an organization.
Return type
notification nstance
Parameters
| Name | Data Type | Requried? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the notification. |
notificationId | long | y | The ID of the notification to return. |
verbose | boolean | n | A boolean indicating whether to return detailed results. Default = false |
GET/ notifications/{organizationId}/reports
Description
Retrieve the notifications for an organization with start date range.
Return type
notifications instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The ID of the organization containing the notification reports. |
startTime | long | n | The range of notification start date begin time. Unix epoch date/time |
endTime | long | n | The range of notification start date end time. Unix epoch date/time |
notificationStatus | string | n | The status of notification processing. Options: Active or Inactive. |
pageNumber | int | y | The page number of the notification reports to return. |
Notification Report Data Model
{
"message": "OK",
"result": {
"startDate": 1397658582969,
"accountId": 8800387990064,
"broadcastContacts": {
"contactIds": [
4402341479113,
4402341478985
],
"contactSearchType": "AllOr",
"enableGroupCalendar": false
},
"endDate": 1397662182969,
"transformed": true,
"organizationId": 8800387990263,
"type": "Polling",
"id": 4402341512992,
"notificationStatus": "Inprogress",
"productSource": "MNIV",
"priority": "NonPriority",
"oldAwareCAMPID": 5500072,
"createdDate": 1397658582969,
"hasNotification": true,
"createdName": "Allen Lai",
"status": "A",
"notificationResult": {
"notificationId": 0,
"unreachableCount": 0,
"confirmedCount": 1,
"externalId": "12",
"createdId": 4402341478524,
"callResultByPaths": [
{
"journalId": 1158726212,
"attemptOrder": 0,
"waitTime": 0,
"cycleSeq": 0,
"path": "Email",
"pathText": "[email protected]",
"callResult": "Not Attempted - Duplicate Contact Information",
"firstName": "Allen-CA",
"lastName": "Lai"
}
],
"confirmed": false
}
]
},
"resourceBundleId": 8800387990350,
"launchtype": "SendNow",
"publicMessages": {},
"message": {
"accountId": 0,
"organizationId": 0,
"contentType": "Text",
"id": 0,
"title": "Meeting!",
"textMessage": "Hi Team,\nThere will be a meeting on 10APR 9:00pm for discussions about the \\\"XXX\\\" plan. Please feel free to join.\nAny concerns, please contact internal line #2323.\"",
"conferenceBridgeId": 0,
"useCustomEmail" : false,
"resourceBundleId": 0,
"questionaire": {
"inputOptionAllowable": false,
"multipleSelected": false,
"answers": [
{
"quotaNum": 0,
"name": "I'm available"
},
{
"quotaNum": 0,
"name": "I'm not available"
}
],
"required": false
},
"lastModifiedId": 0,
"createdId": 0
},
"broadcastSettings": {
"throttlDefaultAmount": 0,
"throttle": false,
"mobileSettings": {
"requestComment": false,
"requestImage": false,
"requestLocation": false,
"allowShare": false,
"requireConfirm": false,
"pushAlertEnabled": false
},
"deliverPaths": [
{
"accountId": 8800387990064,
"pathId": 219910915489807,
"organizationId": 8800387990263,
"awarePathId": 3512042,
"id": 4402341481756,
"expose": true,
"isDefault": true,
"createdDate": 1386673307105,
"createdName": "Allen lai",
"status": "A",
"mandatory": false,
"resourceBundleId": 8800387990350,
"editable": true,
"seq": 8,
"lastModifiedDate": 1392103988481,
"lastModifiedId": 4402341478524,
"createdId": 4402341478524,
"prompt": "Numeric Pager",
"lastModifiedName": "Allen lai",
"extRequired": false,
"displayFlag": false,
"default": true
}
],
"requirePinForMessage": false,
"deliveryMethodInterval": 0,
"bookConference": false,
"cycleInterval": 0,
"duration": 1,
"senderCallerInfos": [
{
"countryName": "United States",
"accountId": 0,
"countryCode": "US",
"resourceBundleId": 0,
"organizationId": 0,
"id": 0,
"callerId": "7812345431",
"isDefault": false,
"createdId": 0,
"lastModifiedId": 0
},
{
"countryName": "China",
"accountId": 0,
"countryCode": "CN",
"resourceBundleId": 0,
"organizationId": 0,
"id": 0,
"callerId": "12691059798",
"isDefault": true,
"createdId": 0,
"lastModifiedId": 0
}
],
"contactCycles": 1,
"language": "en_US",
"recipientApp": false,
"senderEmail": "[email protected]",
"confirm": false,
“enableSecureNotification”: false
},
"source": "Web",
"batchNotificationId": 0,
"stoppedBy": 0,
"lastModifiedDate": 1397658620035,
"lastModifiedId": 4402341478524,
"createdId": 4402341478524,
"processedBy": "q1srapi2",
"lastModifiedName": "Allen lai"
}
}
PUT /notifications/{organizationId}/{notificationId}
Description
Update a notification.
Stop a Notification: A full notification JSON can be passed as input, but the only portion that will honored is notificationStatus.
{
"notificationStatus": "Stopped"
}
Return type
Notification instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The organization from which to initiate the notification. |
notificationId | long | y | The ID of this notification to return. |
notification | NotificationWrapper | y | A Notification object defining the state of the updated notification. |
POST /notifications/{organizationId}
Description
Initiate an immediate notification.
Only notifications with broadcastSettings.launchtype or SendNow are allowed for this method. If you need to create a scheduled or recurring notification, use the Launch Policies API.
NOTE: To launch a notification template, use the following JSON format, where the numeric string is the template ID.
{
"sourceTemplateId":57178899611649
}
NOTE: If you use a sourceTemplateId, you will NOT be able to override any elements of the notification template including the contacts.
Return type
notification instance
Parameters
| Name | Data Type | Required? | Description |
|---|---|---|---|
credentials | string | y | Basic Authorization header. |
organizationId | long | y | The organization from which to initiate the notification. |
notification | NotificationWrapper | y | A Notification object to send. Note that only notifications with launchtype of SendNow are accepted by this method. To create scheduled or recurring notifications, use the /launchPolicies method. |