Avaya 16-300272 ManageDistributionLists

Appendix A Push XML API

Push XML Reference

Broadcast Server User Guide

68

ManageDistributionLists

The following sample XML for ManageDistributionLists and its child

elements illustrates creating the distribution list named “accounting” and

adding several devices to that list.

<ManageDistributionLists>

<DistributionList id="2" name="accounting" action="create">

</DistributionList>

<DistributionList id="2" name="accounting" action="add">

<Member device_id="000E8349D6ED"/>

<Member device_id="0009B7F3FA1D"/>

<Member device_id="000821381711"/>

</DistributionList>

</ManageDistributionLists>

The following table describes the ManageDistributionLists element and

its child elements.

Element Parent Element Attributes Enumeration Description

ManageDistributionLists none none Parent element of one or more

DistributionList elements.

DistributionList ManageDistributionLists Parent element of zero or more

Member elements.

id A numeric value that uniquely

identifies the distribution list.

name A text string that identifies the

distribution list.

operation create

add

remove

delete

Creates a distribution list.

Adds the specified members to

the distribution list.

Removes the specified

members from the distribution

list.

Deletes the distribution list.

Member DistributionList device_id The MAC address of the

device.

Contents

Main Page Contents Preface Page Page Page Preface Page Chapter 1 Introduction to Broadcast Server Broadcast Server Overview Users Subscribers and Distribution Lists Alerts Sending Alerts BCS Interaction with Phones Opening and Using the Broadcast Server Interface Configuring Broadcast Server Initial Configuration Broadcast Server Maintenance Chapter 2 Application Gateway and Broadcast Server Operation Page Chapter 3 System Management Component Versions Server configuration Support items Home page tips Page Chapter 4 System Messages Page Chapter 5 User Management The User Management List Page The User Page User information Password Shared distribution list access General user permissions Alert access Page Chapter 6 Subscriber Management The Subscriber Management List Page The Subscriber Page Subscriber information Subscriber settings Distribution list membership Chapter 7 Distribution List Management The Distribution List Page Automatically created distribution lists List ownership Sharing distribution lists Page The Distribution List Membership Page Adding and removing distribution list members The Distribution List User Permissions Page Granting users permission to send to the list Revoking users permission to send to the list Page Chapter 8 Media Management The Media List System media Media ownership Media linkage The Media Page Uploading a media file Supported graphic formats Supported audio formats Page Chapter 9 External Service Management The External Services Management List The External Service Page Page Page Chapter 10 Broadcast Alert Management The Alert List Column Descriptions Alert Types Emergency alerts Normal alerts Background alerts Page The Alert Page Page Page Page Chapter 11 My Preferences Page Chapter 12 Troubleshooting Common problems Page Appendix A Push XML API Preparing the Application Gateway and an Application to Use the Push XML API Push XML API Operation PushMessage Request Recipient Subject, Body, Image, Audio, Button Schedule DistributionList Request Member ServerRegistration Response Subscribers Response PushMessageResponse Response Push XML Reference Character Set and Character Entities XML Declaration ManagePushMessage The following table describes the ManagePushMessage element and its child elements. Page Page ManageDistributionLists The following table describes the ManageDistributionLists element and its child elements. ServerRegistration Subscribers PushMessageResponse Sample ASP Pages distribution_list.asp Page schedule_message.asp