Manuals / Nortel Networks / Computer Equipment / Server

Nortel Networks Broadcast Server ManagePushMessage, Parent Element, Attributes, Enumeration

Models: Broadcast Server

1 84

Download 84 pages 54.53 Kb

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

Nortel Networks Broadcast Server warranty ManagePushMessage, Parent Element, Attributes, Enumeration, Description

Contents

Nortel Application Gateway 1000/2000 Broadcast Server User GuideConfiguration and Operation Nortel Application Gateway ReleasePage Opening and Using the Broadcast Server Interface ContentsConfiguring Broadcast Server Initial ConfigurationShared distribution list access General user permissions Alert access The User Page User information PasswordThe Subscriber Management List Quick FAQ The Subscriber Page Subscriber settingsC H A P T E R 12 Troubleshooting C H A P T E R 9 External Service ManagementThe External Services Management List Quick FAQ The External Service PageDistributionList Request Member ServerRegistration Response Recipient Subject, Body, Image, Audio, Button ScheduleSubscribers Response PushMessageResponse Response Push XML Reference Character Set and Character Entities XML DeclarationAudience PrefaceOrganization Related Documentation Related Documentationviii Broadcast Server User Guide Configuring Broadcast Server, page Opening and Using the Broadcast Server Interface, pageChapter Introduction to Broadcast ServerUsers, page Subscribers and Distribution Lists, page Alerts, page Broadcast Server OverviewSending Alerts, page BCS Interaction with Phones, page Subscribers and Distribution Lists UsersAlerts BCS Interaction with Phones Sending AlertsOpening and Using the Broadcast Server Interface Initial Configuration Configuring Broadcast ServerBroadcast Server Maintenance Chapter Application Gateway and Broadcast Server Operation10 Broadcast Server User Guide Chapter 2 Application Gateway and Broadcast Server OperationComponent Versions System ManagementChapter Run configuration wizard Server configurationAdministrative contact Feature request URLHome page tips 14 Broadcast Server User Guide Chapter 3 System Management Home page tipsSystem Messages Quick FAQCheck the Show only new, critical messages checkbox at Click here to send this message to the support group link16 Broadcast Server User Guide Chapter 4 System Messages Quick FAQThe User Management List User ManagementChapter Quick FAQ Administrator userChapter 5 User Management Quick FAQ 18 Broadcast Server User GuideThe User Page PasswordUser information General user permissions Shared distribution list accessAlert access 22 Broadcast Server User Guide Chapter 5 User Management The User PageThe Subscriber Management List Subscriber ManagementChapter Distribution List Management page and modify the list’s Go to the Distribution List Management page, select theQuick FAQ Chapter 6 Subscriber Management Quick FAQThe Subscriber Page Subscriber settingsSubscriber information Emergency alerts are not subject to this setting settingDistribution list membership subscriber. Emergency alerts are not subject to thisThe Distribution List Page Distribution List ManagementChapter List ownership Automatically created distribution listsChapter 7 Distribution List Management The Distribution List Page 28 Broadcast Server User GuideQuick FAQ Sharing distribution listsThe Distribution List Page The Distribution List Membership Page Adding and removing distribution list members The Distribution List User Permissions PageRevoking users’ permission to send to the list Granting users permission to send to the list34 Broadcast Server User Guide The Media List Media ManagementChapter System media Media linkage Media ownershipQuick FAQ Uploading a media file The Media PageSupported graphic formats Microsoft Windows wave audio format Supported audio formats40 Broadcast Server User Guide Chapter 8 Media Management The Media PageThe External Services Management List External Service ManagementChapter Quick FAQ The External Service PageChapter 9 External Service Management Quick FAQ 42 Broadcast Server User GuideThe URL field contains the URL that will be passed to devices that allows them to access the service 44 Broadcast Server User Guide Chapter 9 External Service Management The External Service PageThe Alert List Broadcast Alert ManagementChapter Column Descriptions Emergency alerts Alert TypesNormal alerts Background alertsChapter 10 Broadcast Alert Management Quick FAQ Quick FAQ48 Broadcast Server User Guide Alert active checkbox The Alert PageTitle Deliver this alert forSend to the following Prioritydistribution lists Button definitionsChapter 10 Broadcast Alert Management The Alert Page Use audio alert52 Broadcast Server User Guide Chapter 10 Broadcast Alert Management The Alert PageSetting the maximum list entries to display Changing your passwordMy Preferences Set the number of alerts per page54 Broadcast Server User Guide Chapter 11 My Preferences Setting the maximum list entries to displayCommon problems TroubleshootingChapter 56 Broadcast Server User Guide Chapter 12 Troubleshooting Common problemsPush XML API Appendix APush XML API Operation, page Push XML Reference, page Sample ASP Pages, pageTo program an application to use the Push XML API To enable the Push XML API on the Application GatewayPushMessage Request Push XML API OperationPushMessage Request, page DistributionList Request, page ServerRegistration Response, page Subscribers Response, pageSubject, Body, Image, Audio, Button RecipientRecipient, page Subject, Body, Image, Audio, Button, page Schedule, pageSchedule Member DistributionList RequestMember, page Subscribers Response ServerRegistration ResponsePushMessageResponse Response Character Set and Character Entities Push XML ReferenceXML Declaration Character Set and Character Entities, page XML Declaration, pageElement ManagePushMessageParent Element AttributesParent Element ElementAttributes EnumerationParent Element ElementAttributes EnumerationManageDistributionLists ManageDistributionListsDistributionList id=2 name=accounting action=create /DistributionList DistributionList ManageDistributionListsSubscribers ServerRegistrationElement PushMessageResponseParent Element Attributesdistributionlist.asp Sample ASP Pagesdistributionlist.asp, page schedulemessage.asp, page Load the XML into an XMLDOM object Appendix A Push XML API Sample ASP Pages72 Broadcast Server User Guide The image paths and IP addresses in schedulemessage.asp are examples schedulemessage.aspAppendix A Push XML API Sample ASP Pages Broadcast Server User GuideTell the user what happened Appendix A Push XML API Sample ASP Pages74 Broadcast Server User Guide Page Configuration and Operation Broadcast Server User GuideNortel Application Gateway 1000/2000 Copyright 2008 Nortel Networks. All Rights Reserved