Nortel Networks Broadcast Server warranty DistributionList Request, Member

Page 70

Appendix A Push XML API

Push XML API Operation

DistributionList Request

The Push XML API enables you to push an alert to specific devices and/or distribution lists. A distribution list is composed of subscribers, which are IP phones that have registered with the Application Gateway. When an IP phone registers with the Application Gateway, the Application Gateway notifies your application about the new subscriber, as described in “Subscribers Response,” page 63. You can then use your application to create distribution lists from the subscriber information.

The Application Gateway uses the DistributionListRequest element to maintain the distribution lists specified with PushMessage. To send more than one DistributionListRequest, you wrap the elements in a ManageDistributionLists element.

The DistributionListRequest element attributes specify a name for the distribution list and the action that the Application Gateway is to perform on the list: create a new list, add or remove devices, and remove the list.

The following DistributionListRequest child element defines the distribution list:

Member, page 62

Note See “ManageDistributionLists,” page 68 for a detailed explanation of the XML.

Member

One or more Member elements can be included in a DistributionListRequest element. The Member element has one attribute that specifies the device ID (that is, the MAC address of the phone).

62Broadcast Server User Guide

Image 70

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 Audience PrefaceOrganization Related Documentation 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 Server Initial ConfigurationBroadcast 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 User PasswordUser 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 settingsSubscriber information Emergency alerts are not subject to this setting 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 linkageUploading a media file MediaSupported 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 MemberSubscribers Response ServerRegistration ResponsePushMessageResponse Response Character Set and Character Entities Push XML ReferenceXML 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 Page Configuration and Operation Broadcast Server User Guide