Avaya 16-300272 manual To enable the Push XML API on the Application Gateway

Page 66

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:

1Upload 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.

2Enter 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:

1Configure the application to send XML requests and to receive XML responses over the Application Gateway’s push port via HTTP.

2Create 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:

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

2Verify that the phone received the alert.

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

4Verify that your application received confirmation that the alert was delivered and viewed.

58Broadcast Server User Guide

Image 66

Contents Broadcast Server User Guide Release 2.1 Service Pack Copyright 2004-2006,Avaya Inc All Rights Reserved Contents A P T E R 6 Subscriber Management A P T E R 9 External Service Management Vi Broadcast Server User Guide Preface AudienceRelated Documentation Related Documentation Viii Broadcast Server User Guide Chapter Introduction to Broadcast ServerBroadcast Server Overview Users Subscribers and Distribution ListsAlerts Sending Alerts BCS Interaction with PhonesOpening and Using the Broadcast Server Interface Configuring Broadcast ServerInitial Configuration Broadcast Server Maintenance Application Gateway and Broadcast Server Operation Application Gateway and Broadcast Server Operation System Management Component VersionsServer configuration Support itemsHome page tips System Management Home page tips Broadcast Server User Guide Quick FAQ System MessagesSystem Messages Quick FAQ Broadcast Server User Guide User Management User Management ListAdministrator user Password UserUser information Shared distribution list access General user permissionsAlert access User Management The User Broadcast Server User Guide Subscriber Management Subscriber Management ListGo to the Distribution List Management page, select Subscriber Subscriber informationSubscriber settings Distribution list membershipDistribution List Management Distribution ListAutomatically created distribution lists List ownershipSharing distribution lists Distribution List Management Distribution List Management Distribution List Membership Distribution List User Permissions Adding and removing distribution list membersGranting users permission to send to the list Revoking users’ permission to send to the listBroadcast Server User Guide Media Management Media ListSystem media Media ownership Media linkageMedia Uploading a media fileSupported graphic formats Supported audio formats WAVMedia Management The Media Broadcast Server User Guide External Service Management External Services Management ListExternal Service External Service Management Page Broadcast Alert Management Alert ListColumn Descriptions Normal alerts Alert TypesEmergency alerts Background alertsBroadcast Alert Management Quick FAQ Alert TitleSend to the following Use audio alert Page My Preferences Changing your passwordSetting the maximum list entries to display Set the number of alerts perPage Troubleshooting Common problemsTroubleshooting Common problems Broadcast Server User Guide Appendix a Push XML APITo enable the Push XML API on the Application Gateway Push XML API Operation PushMessage RequestRecipient Schedule DistributionList Request MemberServerRegistration Response Subscribers ResponsePushMessageResponse Response Push XML Reference Character Set and Character EntitiesXML Declaration ManagePushMessage Element Parent Element Attributes Enumeration DescriptionMessageid Appendix a Push XML API ManageDistributionLists DistributionListServerRegistration SubscribersPushMessageResponse Sample ASP Pages Distributionlist.aspLoad the XML into an Xmldom object Schedulemessage.asp Appendix a Push XML API Sample ASP Pages