Cisco Unity Connection Provisioning Interface (CUPI) API -- Public Lists

From DocWiki

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents

API Overview Index of All CUPI Documentation

Contents 1 Viewing 2 Creating 3 Adding Members

Viewing

To see the public lists on the server, do the following GET request:

GET /vmrest/users/distributionlists

Here is an example of the response you might receive to such a request:

<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><DistributionLists total="2">
<DistributionList>
    <URI>/vmrest/distributionlists/f2463ed4-70ad-4bc7-b983-1e95d898fbae</URI>
    <ObjectId>f2463ed4-70ad-4bc7-b983-1e95d898fbae</ObjectId>
    <Alias>undeliverablemessages</Alias>
    <DisplayName>Undeliverable Messages</DisplayName>
    <LocationObjectId>40a4ab6b-e307-4710-a01f-aa5784fc1274</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/40a4ab6b-e307-4710-a01f-aa5784fc1274</LocationURI>
    <PartitionObjectId>71645d9f-bc0f-4b05-9586-477729a21827</PartitionObjectId>
    <PartitionURI>/vmrest/partitions/71645d9f-bc0f-4b05-9586-477729a21827</PartitionURI>
    <DistributionListMembersURI>/vmrest/distributionlists/f2463ed4-70ad-4bc7-b983-1e95d898fbae/distributionlistmembers</DistributionListMembersURI>
    <AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20f2463ed4-70ad-4bc7-b983-1e95d898fbae)</AlternateNamesURI>
</DistributionList>
<DistributionList>
    <URI>/vmrest/distributionlists/f2a17654-eb37-4445-89f3-f094a0bd52a2</URI>
    <ObjectId>f2a17654-eb37-4445-89f3-f094a0bd52a2</ObjectId>
    <Alias>allvoicemailusers</Alias>
    <DisplayName>All Voice Mail Users</DisplayName>
    <LocationObjectId>40a4ab6b-e307-4710-a01f-aa5784fc1274</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/40a4ab6b-e307-4710-a01f-aa5784fc1274</LocationURI>
    <DtmfAccessId>99991</DtmfAccessId>
    <PartitionObjectId>71645d9f-bc0f-4b05-9586-477729a21827</PartitionObjectId>
    <PartitionURI>/vmrest/partitions/71645d9f-bc0f-4b05-9586-477729a21827</PartitionURI>
    <DistributionListMembersURI>/vmrest/distributionlists/f2a17654-eb37-4445-89f3-f094a0bd52a2/distributionlistmembers</DistributionListMembersURI>
    <AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20f2a17654-eb37-4445-89f3-f094a0bd52a2)</AlternateNamesURI>
</DistributionList>

Many of these fields are consistent with what you see on other objects.

Creating

The following POST creates a public distribution list. In this example, it would be called "Test DL" and have an extension of 8001. The extension here is optional.

POST /vmrest/distributionlists

<?xml version="1.0" encoding="UTF-8"?>
<DistributionList>
    <Alias>TestDL</Alias>
    <DisplayName>Test DL</DisplayName>
    <DtmfAccessId>8001</DtmfAccessId>
</DistributionList>

Adding Members

The following example shows how to add a user as a member of a public distribution list. The user can be either a local user with a mailbox or a global user (i.e. a user from another cluster in the same network).

POST /vmrest/distributionlists/{distribution list object id}/distributionlistmembers 
<?xml version="1.0" encoding="UTF-8"?>
<DistributionListMember>
    <MemberUserObjectId>{user object ID}</MemberUserObjectId>
</DistributionListMember>

The following example shows how to add another public distribution list as a member of a public distribution list.

POST /vmrest/distributionlists/{distribution list object id}/distributionlistmembers 
<?xml version="1.0" encoding="UTF-8"?>
<DistributionListMember>
    <MemberDistributionListObjectId>{distribution list object ID}</MemberDistributionListObjectId>
</DistributionListMember>