Broadcast Server User Guide

Appendix A Push XML API

Preparing the Application Gateway and an Application to Use the Push XML API

Preparing the Application Gateway and an

Application to Use the Push XML API

To send alerts from a third-party application to IP phones through the

Push XML API, you must enable the Push XML API on the Application

Gateway and program the application to send XML to the Application

Gateway.

To enable the Push XML API on the Application Gateway:

1 Upload a Broadcast Server license to the Application Gateway.

The Broadcast Server license opens a port on the Application Gateway for

communication with a third-party application.

2 Enter the URL of the application in the Application Gateway

Administration Tool on the Operation > Voice Office > IP Phone page.

The Application Gateway needs the application URL so that it can send the

application the IP address and push port to use when sending XML to the

Application Gateway.

To program an application to use the Push XML API:

1 Configure the application to send XML requests and to receive XML

responses over the Application Gateway’s push port via HTTP.

2 Create an interface for composing and sending distribution list and alert

requests.

“Sample ASP Pages,” page 71 contains sample ASP pages for sending the

XML code for a distribution list and an alert to the Application Gateway.

To test the connection between the Application Gateway and the

application:

1 Compose a simple alert in your application and send it to one test phone.

2 Verify that the phone received the alert.

3 On the phone, click the OK or Exit soft key to dismiss the alert.

4 Verify that your application received confirmation that the alert was

delivered and viewed.