Nortel Networks Broadcast Server warranty ServerRegistration Response, Subscribers Response

Page 71

Appendix A Push XML API

Push XML API Operation

ServerRegistration Response

The ServerRegistration element is a response sent from the Application Gateway to the application after you submit the application’s URL through the Application Gateway Administration Tool. The ServerRegistration element content consists of the Application Gateway IP address and the port over which it will listen for XML strings from the application.

Note See “ServerRegistration,” page 69 for a detailed explanation of the XML.

Subscribers Response

The Subscribers element is a response sent from the Application Gateway to the application after an IP phone registers with the Application Gateway. The Subscribers element attributes define the following:

•The device, which is either the user name associated (in an LDAP directory) with the device or the phone model.

•The department associated with the phone or user (obtained from the Application Gateway connection to your LDAP server).

•The device ID (MAC address).

•The extension associated with the phone or user (obtained from LDAP).

•The action, either add, update, or remove.

Note See “Subscribers,” page 69 for a detailed explanation of the XML.

PushMessageResponse Response

The PushMessageResponse element is a response sent from the Application Gateway to the application after pushing an alert. The contents of the PushMessageResponse element is either "0" (the push was successful) or a negative number (indicating an error condition).

Note See “PushMessageResponse,” page 70 for a detailed explanation of the XML.

Broadcast Server User Guide

63

Image 71

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