Avaya 16-300272 User Manual

Page of 82
Appendix
Broadcast Server User Guide
57
A
Push XML API
Broadcast Server communicates with the Application Gateway through 
the Push XML API. You can use that same interface to send alerts from 
other applications to IP phones. For example, you might wish to send call 
center statistics, sales updates, or automated IT alerts. 
To use the Push XML API, your application sends a request as an XML 
string over HTTP to the Application Gateway.
The Application Gateway uses the request to compose, schedule, and 
distribute the alert to IP phones. The Application Gateway then sends a 
response back to your application containing alert status and error 
information. The response returned to your application is an XML string 
sent over HTTP.
The XML that your application sends to the Application Gateway defines 
the parameters of the alert request, including the alert contents and 
priority, the intended recipients, and a push schedule. An alert can include 
a title, image, text, soft keys, and audio. 
The following topics describe the Push XML API and how to use it to send 
alerts from third-party applications to IP phones: