Cisco Unity Connection Provisioning Interface (CUPI) API -- Distribution List APIs
Distribution List APIs
Administrator can use this API to create/update/delete/fetch the distribution lists. You can update various attributes of distribution list using this API. Also members in a distribution list can be added/deleted/fetched using this API.
Listing the Distribution Lists
The following is an example of the GET request that fetch the list of distribution 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
To get distribution lists, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Listing Specific Tenant Related Distribution Lists by System Administrator
In Cisco Unity Connection 10.5(2) and later, the system administrator can use TenantObjectID to list the specific tenant related distribution lists using the following URI:
|
To get the TenantObjectID, use the following URI:
|
Viewing the Specific Distribution List
The following is an example of the GET request that lists the details of specific distribution list represented by the provided value of distribution list object ID:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To get a distribution list for a particular partitions, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Getting the Distribution List Based on an Query
The following is an example of the GET request that lists the details of specific distribution list represented by the provided value of partition object ID:
|
Where the partition object Id can be fetched using the following request
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To get a particular distribution list, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Creating a Distribution List
The following is an example of the POST request that creates a new distribution list where the mandatory field is alias:
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
JSON Example
To create distribution list, do the following:
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
Delete the Distribution List
This request can be used to delete a distribution 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
To delete a distribution list, do the following:
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
Updating the Distribution List
The following is an example of the PUT request that can be used to update the distribution list by replicating remote sites over inter-site links, adding contacts in distribution list, and accepting messages from foreign systems.
|
Example 1: Replicate to remote sites over inter-site links is enabled, disable add contacts in distribution list, and disallow messages from users on remote voice messaging systems that are configured as VPIM locations.
|
|
JSON Example:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Example 2: Replicate to remote sites over inter-site links is disabled, enable add contacts in distribution list, and disallow messages from users on remote voice messaging systems that are configured as VPIM locations.
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Example 3: Replicate to remote sites over inter-site links is enabled, enable add contacts in distribution list, and accept messages from users on remote voice messaging systems that are configured as VPIM locations.
|
Updating the Distribution List for Tenant
The following is an example of the PUT request that can be used to update the distribution list for Tenants.
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
The following is the response from the above *PUT* request:
|
JSON Example :
|
Updating the Alternate Names of Distribution Lists
The mandatory fields for creation of an alternate name are FirstName and DistributionListObjectId. The URI to get DistributionListObjectId: https://<connection server>/vmrest/distributionlists.
Example 1: Adding an alternate name for a distribution list
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Example 3: Deleting an alternate name
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
Example 4: Editing an Alternate Name
Note that only first name is editable.
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Explanation of the Data Fields for Distribution List
| Parameter | Operation | Data Type | Comments |
|---|---|---|---|
| Alias | Read/Write | String(64) | Unique name for a distribution List |
| AllowContacts | Read/Write | Boolean | A flag indicating whether contacts (system,
VPIM,virtual) are allowed to be members of this Distribution List. Purpose of
this flag is to enable administrators to create a Distribution List whose
members are Contacts.
Possible values:
Default: false |
| AllowForeignMesssage | Read/Write | Boolean | Allow users on remote voice messaging
systems that are configured as VPIM locations to send messages to this
distribution list. Only valid if the list is for subscribers only (i.e. does
not allow contacts)
Possible Values:
Default: False |
| CreationTime | Read Only | Datetime | The date and time the system distribution list was created in UTC |
| DisplayName | Read/Write | String(64) | The unique text name of the system distribution. |
| DtmfAccessId | Read/Write | String(40) | Extension that the phone system uses to connect to the distribution list.It is an optional field. |
| DtmfName | Read Only | String(64) | The series of digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the display name of the system distribution list. These digits are used for searching the distribution list by name via the phone. |
| LocationObjectId | Read Only | String(16) | The unique identifier of the LocationVMS object to which this system distribution list belongs. |
| ObjectId | Read Only | String(36) | Object Id of the distribution list created. |
| PartitionObjectId | Read Only | String(36) | The unique identifier of the Partition to which the DistributionList is assigned. |
| TenantObjectId | Read/Write | String(36) | The unique identifier of the tenant to which the distribution list belongs. This field is reflected in the response only if the distribution list belongs to a particular tenant. |
| VoiceName | Read/Write | String(40) | The voicename of the distribution List |
| URI | Read Only | String | URI of the Distribution list |
| VoiceFileURI | Read Only | String | URI of Voice File |
| VoiceNameURI | Read Only | String | Voice Name URI |
| LocationURI | Read Only | String | Location URI |
| PartitionURI | Read Only | String | Partition URI |
| PartitionURI | Read Only | String | Distribution List URI |
| AlternameNamesURI | Read Only | String | Alternate Names URI |
Explanation of the Data Fields for Alternate Names of Distribution List
| Parameter | Operation | Data Type | Comments |
|---|---|---|---|
| First Name | Read/Write | String (64) | Specifies the alternate name of a distribution list. |
| ObjectId | Read Only | String (36) | Specifies the objectid of the alternate name. |
| DistributionListObjectId | Read Only | String (36) | Specifies the object ID of the distribution list. |
| URI | Read Only | String | Specifies the URI of the alternate name. |
| DistributionListURI | Read Only | String | Specifies the URI of distribution list. |
Feedback