Push Xml Api Operation; Pushmessage Request - Nortel Broadcast Server User Manual

Push XML API Operation

PushMessage Request

Once the Application Gateway is aware of a third-party application, it
performs the following operations:
Listens for XML data from the application, including distribution lists
•
to track for the application and alerts to be pushed.
Sends information about the devices that register with the Application
•
Gateway to the application, as they come online or change.
Maintains distribution lists.
•
Pushes alerts from the application over port 9998 to the phones
•
according to the defined schedule.
Updates the alert list on the phones, automatically removing alerts
•
that are deleted or expired.
Notifies the application about the status of the pushed alerts.
•
The following topics provide a general description of the XML elements
used in those operations:
PushMessage Request, page 59
•
DistributionList Request, page 62
•
ServerRegistration Response, page 63
•
Subscribers Response, page 63
•
PushMessageResponse Response, page 63
•
The PushMessage element defines the alert to be pushed to a distribution
list. To send more than one PushMessage, you wrap the elements in a
ManagePushMessage element.
The PushMessage element attributes specify the priority and action of the
alert. Alert priority determines whether it will be pushed:
Immediately and take control of the audio. Priority = emergency.
•
When the phone is idle. Priority = normal.
•
Only to the alert history item in the Voice Office menu. Priority =
•
background.
Appendix A
Push XML API Operation
Broadcast Server User Guide
Push XML API
59