Nortel Networks Broadcast Server warranty ServerRegistration, Subscribers

Page 77

Appendix A Push XML API

Push XML Reference

ServerRegistration

ServerRegistration is sent from the Application Gateway to the application URL specified in the Operation > Voice Office > IP Phone page of the Application Gateway Administration Tool. The ServerRegistration element provides your application with the Application Gateway IP address and port to which it should send XML strings.

Sample XML for ServerRegistration follows:

<ServerRegistration>http://AG_IPAddr:port</ServerRegistration>

Subscribers

Subscribers, sent from the Application Gateway to your application, provides the application with the subscribers which you can specify as individual alert recipients and/or members of a distribution list.

Sample XML for Subscribers and its child elements follows:

<Subscribers>

<Device name="user" dept="maintenance" action="add“ device_id="000E8349D6ED" extn="2027" class="model"/> device_id="000821381711" extn="2029" class="model"/>

<Device name="user" dept="marketing" action="update“ device_id="0009B7F3FA1D" extn="3015" class="model"/>

</Subscribers>

Element	Parent Element	Attributes	Enumeration	Description

Subscribers	none			Parent element of one or more
				Device elements.

Device	Subscribers			The IP phones that have
				registered with the Application
				Gateway and can be named as
				alert recipients or distribution
				list members.

		name		Either the user name
				associated (in an LDAP
				directory) with the device or
				the phone model.

Broadcast Server User Guide

69

Image 77

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