Cisco Unity Express -- Public Distribution Lists REST PI Service Operation
From DocWiki
Main page: Cisco Unity Express -- REST PI Service Operations
Previous page: Cisco Unity Express -- Notification Settings REST PI Service Operation
Next page: Cisco Unity Express -- Voicemail Settings REST PI Service Operation
Search the Cisco Unity Express documentation on the DocWiki:
Contents |
Public Distribution Lists
Classes
Figure 28: Distribution List
ListElementType
| Class Name |
ListElementType (Enumeration Class) |
|---|---|
| Extends From | |
| Description |
Enumeration of type of elements that populate a public distribution list |
| XML Namespace |
http://distributionlist.model.rest.voicemail.aesop.cisco.com |
| Enum Values |
USER, GROUP, GDM, LIST, REMOTE_USER, REMOTE_BLIND, NON_SUBSCRIBER |
ListElement
| Class Name |
ListElement | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing a distribution list member | ||
| XML Namespace |
http://distributionlist.model.rest.voicemail.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
memberId |
String |
Identifier for the list element | |
|
phoneNumber |
String |
Phone number of the list member | |
|
type |
ListElementType |
Type of the list member |
DistributionList
| Class Name |
DistributionList | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing a public distribution list | ||
| XML Namespace |
http://distributionlist.model.rest.voicemail.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
description |
String |
List description | |
|
listName |
String |
Name of the public list | |
|
listNumber |
String |
Number of the distribution list | |
|
members |
ListElement (collection) |
Collection of the members of this public list | |
|
owners |
ListElement (collection) |
Collection of the owner of this public list |
Resources
| Resource URI | Operation | Input | Return Value |
|---|---|---|---|
|
/voicemail/publiclists |
GET (Read all public lists) |
BaseElementList containing a collection of DistributionList objects | |
|
POST (Create a new public distribution list) |
DistributionList (Including list of member and owners ) | ||
|
/voicemail/publiclists/{listname} |
GET (Read a public list, including its members and owners) |
DistributionList (Including list of member and owners ) | |
|
PUT (Update list information) | |||
|
DELETE (Delete list) | |||
|
/voicemail/publiclists/{listname}/members |
GET (Read members of a public list) |
BaseElementList containing a collection of ListElement objects | |
|
/voicemail/publiclists/{listname}/members/add |
PUT (Add a member to a public list) |
ListElement | |
|
/voicemail/publiclists/{listname}/members/delete |
PUT (Remove a member of public list) |
ListElement | |
|
/voicemail/publiclists/{listname}/owners |
GET (Read owners of a public list) |
BaseElementList containing a collection of ListElement objects | |
|
/voicemail/publiclists/{listname}/owners/add |
PUT (Add an owner to list) |
ListElement | |
|
/voicemail/publiclists/{listname}/owners/delete |
PUT (Remove an owner from list) |
ListElement |
