Avaya 16-300272, User Manual

Page: 70 / 82

Appendix A Push XML API
Push XML API Operation
Broadcast Server User Guide
62
DistributionList Request
The Push XML API enables you to push an alert to specific devices and/or
distribution lists. A distribution list is composed of subscribers, which are
IP phones that have registered with the Application Gateway. When an IP
phone registers with the Application Gateway, the Application Gateway
notifies your application about the new subscriber, as described in
“Subscribers Response,” page 63 . You can then use your application to
create distribution lists from the subscriber information.
The Application Gateway uses the
DistributionListRequest element to
maintain the distribution lists specified with PushMessage . To send more
than one DistributionListRequest , you wrap the elements in a
ManageDistributionLists element.
The DistributionListRequest element attributes specify a name for the
distribution list and the action that the Application Gateway is to perform
on the list: create a new list, add or remove devices, and remove the list.
The following
DistributionListRequest child element defines the
distribution list:
Member, page 62
Note
See “ManageDistributionLists,” page 68 for a detailed explanation of the
XML.
Member
One or more Member elements can be included in a
DistributionListRequest element. The Member element has one attribute
that specifies the device ID (that is, the MAC address of the phone).