Avaya 16-300272 manual Messageid

Page 74

Appendix A Push XML API

Push XML Reference

Element

Parent Element

Attributes

Enumeration

Description

 

 

 

 

 

PushMessage

ManagePushMessage

 

 

Parent of the elements that

 

 

 

 

define the content, recipient,

 

 

 

 

and schedule of an alert.

 

 

 

 

Multiple PushMessage

 

 

 

 

elements can be sent in the

 

 

 

 

same HTML string.

 

 

 

 

 

 

 

message_id

 

A numeric value that uniquely

 

 

 

 

identifies the alert and is used

 

 

 

 

to track status.

 

 

 

 

 

 

 

priority

0

Emergency alert.

 

 

 

1

Normal alert.

 

 

 

2

Background alert.

 

 

 

 

 

 

 

action

push

Push to the display; do not

 

 

 

 

include in alert list.

 

 

 

schedule

Push to the display and alert

 

 

 

 

list.

 

 

 

delete

Delete the alert from the

 

 

 

 

schedule and alert list.

 

 

 

 

 

 

 

reloaded

true

Alert has been pushed to the

 

 

 

 

phone.

 

 

 

false

Alert has not been pushed to

 

 

 

 

the phone. Push it according to

 

 

 

 

the schedule.

 

 

 

 

 

Recipient

PushMessage

id

 

A numeric value that uniquely

 

 

 

 

identifies the recipient.

 

 

 

 

 

 

 

type

device

This recipient is a device.

 

 

 

distribution

This recipient is a distribution

 

 

 

 

list.

 

 

 

 

 

Subject

PushMessage

none

 

The alert title text, up to 256

 

 

 

 

characters. The phone display

 

 

 

 

constrains the usable portion

 

 

 

 

of the title to about 20

 

 

 

 

characters.

 

 

 

 

 

Body

PushMessage

none

 

The main text of the alert, up to

 

 

 

 

256 characters.

 

 

 

 

 

Image

PushMessage

none

 

Optional image URL to include

 

 

 

 

with the alert.

 

 

 

 

 

Audio

PushMessage

none

 

Optional audio URL to include

 

 

 

 

with the alert.

 

 

 

 

 

66Broadcast Server User Guide

Image 74
Contents Broadcast Server User Guide Release 2.1 Service Pack Copyright 2004-2006,Avaya Inc All Rights Reserved Contents A P T E R 6 Subscriber Management A P T E R 9 External Service Management Vi Broadcast Server User Guide Related Documentation PrefaceAudience Related Documentation Viii Broadcast Server User Guide 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 ServerInitial Configuration Broadcast 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 information PasswordUser 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 informationSubscriber settings 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 linkageSupported graphic formats MediaUploading a media file 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 MemberPushMessageResponse Response ServerRegistration ResponseSubscribers Response XML Declaration Push XML ReferenceCharacter Set and Character Entities 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