Nortel Networks Broadcast Server warranty Appendix a, Push XML API

Page 65

Appendix 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:

•Preparing the Application Gateway and an Application to Use the Push XML API, page 58

•Push XML API Operation, page 59

•Push XML Reference, page 64

•Sample ASP Pages, page 71

Broadcast Server User Guide

57

Image 65

Contents Broadcast Server User Guide Page Contents A P T E R 6 Subscriber Management A P T E R 9 External Service Management Vi Broadcast Server User Guide Organization PrefaceAudience Related Documentation Introduction to Broadcast Server ChapterBroadcast Server Overview Subscribers and Distribution Lists UsersAlerts BCS Interaction with Phones Sending AlertsOpening and Using the Broadcast Server Interface Initial Configuration Configuring Broadcast ServerBroadcast Server Maintenance Application Gateway and Broadcast Server Operation Application Gateway and Broadcast Server Operation Component Versions System ManagementSupport items Server configurationHome page tips System Management Home page tips Broadcast Server User Guide System Messages Quick FAQSystem Messages Quick FAQ Broadcast Server User Guide User Management List User ManagementAdministrator user User information PasswordUser General user permissions Shared distribution list accessAlert access User Management The User Broadcast Server User Guide Subscriber Management List Subscriber ManagementGo to the Distribution List Management page, select Subscriber information Subscriber settingsSubscriber Distribution list membership Emergency alerts are not subject to this settingDistribution List Distribution List ManagementList ownership Automatically created distribution listsSharing distribution lists Distribution List Management Distribution List Management Distribution List Membership Adding and removing distribution list members Distribution List User PermissionsRevoking users’ permission to send to the list Granting users permission to send to the listBroadcast Server User Guide Media List Media ManagementSystem media Media linkage Media ownershipSupported graphic formats MediaUploading a media file WAV Supported audio formatsMedia Management The Media Broadcast Server User Guide External Services Management List External Service ManagementExternal Service External Service Management Page Alert List Broadcast Alert ManagementColumn Descriptions Emergency alerts Alert TypesNormal alerts Background alertsBroadcast Alert Management Quick FAQ Title AlertSend to the following Use audio alert Page Setting the maximum list entries to display Changing your passwordMy Preferences Set the number of alerts perPage Common problems TroubleshootingTroubleshooting Common problems Broadcast Server User Guide Push XML API Appendix aTo enable the Push XML API on the Application Gateway PushMessage Request Push XML API OperationRecipient Schedule Member DistributionList RequestPushMessageResponse Response ServerRegistration ResponseSubscribers Response XML Declaration Push XML ReferenceCharacter Set and Character Entities Element Parent Element Attributes Enumeration Description ManagePushMessageMessageid Appendix a Push XML API DistributionList ManageDistributionListsSubscribers ServerRegistrationPushMessageResponse Distributionlist.asp Sample ASP PagesLoad the XML into an Xmldom object Schedulemessage.asp Appendix a Push XML API Sample ASP Pages Page Broadcast Server User Guide Configuration and Operation