Avaya 16-300272 manual Push XML API Operation, PushMessage Request

Page 67

Appendix A Push XML API

Push XML API Operation

Push XML API Operation

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

PushMessage Request

The PushMessage element defines the alert to be pushed to an IP phone or 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.

Broadcast Server User Guide

59

Image 67

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 Audience PrefaceRelated Documentation Related Documentation Viii Broadcast Server User Guide Introduction to Broadcast Server ChapterBroadcast Server Overview Subscribers and Distribution Lists UsersAlerts BCS Interaction with Phones Sending AlertsConfiguring Broadcast Server Opening and Using the Broadcast Server InterfaceInitial Configuration Broadcast 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 PasswordUser information 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 SubscriberDistribution list membership Subscriber settingsDistribution 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 ownershipUploading a media file MediaSupported graphic formats 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 Background alerts Alert TypesEmergency alerts Normal alertsBroadcast Alert Management Quick FAQ Title AlertSend to the following Use audio alert Page Set the number of alerts per Changing your passwordSetting the maximum list entries to display My PreferencesPage 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 RequestSubscribers Response ServerRegistration ResponsePushMessageResponse Response Character Set and Character Entities Push XML ReferenceXML Declaration 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