Nortel Networks Broadcast Server warranty Appendix a Push XML API

Page 75

 

 

 

 

Appendix A Push XML API

 

 

 

 

Push XML Reference

 

 

 

 

 

Element

Parent Element

Attributes

Enumeration

Description

 

 

 

 

 

Button

PushMessage

index

1

Identifies the first soft key.

 

 

 

2

Identifies the second soft key.

 

 

 

 

 

 

 

type

dial

The content of the Button

 

 

 

 

element is a telephone

 

 

 

 

number.

 

 

 

url

The content of the Button

 

 

 

 

element is a Web URL.

 

 

 

 

 

 

 

caption

 

The text that appears with the

 

 

 

 

soft key, up to 32 characters.

 

 

 

 

The button size constraints the

 

 

 

 

usable portion of the caption to

 

 

 

 

about 6 characters.

 

 

 

 

 

Schedule

PushMessage

none

 

Parent element of the

 

 

 

 

Schedule elements.

 

 

 

 

 

begin_date

Schedule

none

 

The date to start and stop the

end_date

 

 

 

push, formatted as

 

 

 

 

mm:dd:yyyy. For example,

 

 

 

 

January 15, 2006 is

 

 

 

 

01:15:2006. The date is based

 

 

 

 

on the Application Gateway

 

 

 

 

date.

 

 

 

 

 

days

Schedule

sunday

0

Do not push the alert on this

 

 

monday

 

day.

 

 

tuesday

1

Push the alert on this day.

 

 

wednesday

 

 

 

 

thursday

 

 

 

 

friday

 

 

 

 

saturday

 

 

 

 

 

 

 

begin_time

Schedule

none

 

The time to start and stop the

end_time

 

 

 

push, formatted as hh:mm:ss

 

 

 

 

AM PM. For example, noon is

 

 

 

 

12:00:00 PM. The time is

 

 

 

 

based on the Application

 

 

 

 

Gateway time.

 

 

 

 

 

Broadcast Server User Guide

67

Image 75
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 Preface AudienceOrganization 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 Password UserUser 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 settings SubscriberSubscriber 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 ownershipMedia Uploading a media fileSupported 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 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 RequestServerRegistration Response Subscribers ResponsePushMessageResponse Response Push XML Reference Character Set and Character EntitiesXML 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