Nortel Networks Broadcast Server warranty ManagePushMessage

Page 73

Appendix A Push XML API

Push XML Reference

ManagePushMessage

The following sample XML for ManagePushMessage and its child elements illustrates scheduling a normal alert to a distribution list named “MainFloor”. The alert includes audio and two soft keys.

<ManagePushMessage>

<PushMessage priority="1" message_id="3" action="schedule" reloaded="{true false}“ <Recipient id="MainFloor" type="distribution"/>

<Subject>Server Maintenance this Week</Subject> <Body>Servers will be taken off-line this week, as follows. </Body> <Audio>http://mysite.com/alerts/alert.wav</Audio> <Button index="1" type="url" caption="Server Usage">

http://mysite.com/it/info/matrix.html</Button>

<Button index="2" type="dial" caption="Help Desk">2323</Button2> <Schedule>

<BeginDate>10:03:2005</BeginDate>

<EndDate>10:07:2005</EndDate>

<Days sunday="0" monday="0" tuesday="1" wednesday="1" thursday="0" friday="1" saturday="0"/>

<BeginTime>07:00:00 AM</BeginTime> <EndTime>09:30:00 AM</EndTime>

</Schedule>

</PushMessage>

</ManagePushMessage>

The following table describes the ManagePushMessage element and its child elements.

Element	Parent Element	Attributes	Enumeration	Description

ManagePushMessage	none	none		Parent element of one or more
				PushMessage elements.

Broadcast Server User Guide

65

Image 73

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 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 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 Subscriber settingsSubscriber information 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 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 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 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 Page Broadcast Server User Guide Configuration and Operation