Private List API
Listing All the Private Lists
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Listing a Particular Private List
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Create a Private list
The mandatory field for creation is DisplayName.
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
Update Private List
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Delete Private List
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
JSON Example
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
Field Name | Data Type | Operation | Description |
---|---|---|---|
DisplayName | String | Read/Write | The preferred text name of the list to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration. |
UserObjectId | String(36) | Read Only | The unique identifier of the User object to which this list belongs. |
DtmfName | String | Read Only | The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the group name. These digits would need to be dialed to address a message to this list via the phone. |
Alias | String | Read Only | The unique text name for either a list |
NumericId | String | Read Only | If being used as a personal voicemail list (i.e., "private" voicemail list), the numeric identifier for the personal group,(Value 0-4) |
IsAddressable | Boolean | Read Only | A flag indicating whether the entity to
which the alias belongs is addressable.
Possible Values:
Default value: true |
ObjectId | String(36) | Read Only | Unique identifier of private List |