DocWiki - User contributions [en]

Cisco Unity Connection API List

2012-02-21T22:53:58Z

Briward:

DRAFT



{| width="100%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/version
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to retrieve the current version of the system.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <pre><nowiki>https://<host>:<port>/vmrest/version</nowiki></pre>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Schema:'''
| style="width: 60%;"| <pre><nowiki>https://10.10.10.10:8443/vmrest/schema/VersionInformation</nowiki></pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| [[Cisco_Unity_Connection_API_List_Examples|Example]]
|}



{| width="100%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/distributionlists
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to work with distribution lists.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <pre><nowiki>https://<host>:<port>/vmrest/distributionlists</nowiki></pre>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET,POST,PUT,DELETE
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| query, sort, pageNumber, rowsPerPage, properties
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Schema:'''
| style="width: 60%;"| <pre><nowiki>https://10.10.10.10:8443/vmrest/schema/DistributionList</nowiki></pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| [[Cisco_Unity_Connection_API_List_Examples|Example]]
|}



{| width="100%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/distributionlists/{objectid}/distributionlistmembers
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to work with distribution lists.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <pre><nowiki>https://<host>:<port>/vmrest/distributionlists/{objectid}/distributionlistmembers</nowiki></pre>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET,POST,PUT,DELETE
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| query, sort, pageNumber, rowsPerPage, properties
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Schema:'''
| style="width: 60%;"| <pre><nowiki>https://10.10.10.10:8443/vmrest/schema/DistributionListMember</nowiki></pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| [[Cisco_Unity_Connection_API_List_Examples|Example]]
|}

Cisco Unity Connection API List

2012-02-21T22:49:07Z

Briward:

Cisco Unity Connection API List Examples

2012-02-21T22:48:15Z

Briward:

== Cisco Unity Connection API List Examples ==

=== Examples for /vmrest/version ===

==== Example 1: GET====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/version</pre>

HTTP RESPONSE:
<pre>
<VersionInformation>
<name>vmrest</name>
<version>8.6.2.0ES3</version>
</VersionInformation>
</pre>

=== Examples for /vmrest/distributionlist ===

==== Example 1: GET ====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</URI>
<ObjectId>92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</ObjectId>
<Alias>undeliverablemessages</Alias>
<DisplayName>Undeliverable Messages</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2092fa35cc-a72e-4f59-83e5-ccf6fce07f1e)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a</URI>
<ObjectId>24f444c9-34ce-4072-9270-672933c7bb3a</ObjectId>
<Alias>allvoicemailusers</Alias>
<DisplayName>All Voice Mail Users</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>99991</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2024f444c9-34ce-4072-9270-672933c7bb3a)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

==== Example 2: GET ====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlists?query=(alias startswith F)&sort=(alias desc)</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</URI>
<ObjectId>de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</ObjectId>
<Alias>FSTDK02</Alias>
<DisplayName>FSTDK02</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>4445</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20de9cb6c5-873c-454b-8fd3-58b7aaf62dd0)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180</URI>
<ObjectId>d3e0c786-0be4-4b72-a27b-c745d1504180</ObjectId>
<Alias>FSTDK01</Alias>
<DisplayName>FSTDK01</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>4444</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20d3e0c786-0be4-4b72-a27b-c745d1504180)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

==== Example 3: POST ====

HTTP POST:
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>

HTTP BODY:
<pre>
<DistributionList>
<Alias>FSTDK03</Alias>
<DisplayName>FSTDK03</DisplayName>
<DtmfAccessId>4446</DtmfAccessId>
</DistributionList>
</pre>

HTTP RESPONSE:
<pre>
/vmrest/distributionlists/5f038b49-5840-4974-b555-fadfaa327024
</pre>

==== Example 4: PUT ====

HTTP PUT:
<pre>https://10.10.10.10:8443/vmrest/distributionlists/{objectid}</pre>

HTTP BODY:
<pre>
<DistributionList>
<DtmfAccessId>4447</DtmfAccessId>
</DistributionList>
</pre>

HTTP RESPONSE:
<pre>
{empty response} Return Code = HTTP/1.1 204 No Content
</pre>

Cisco Unity Connection API List Examples

2012-02-21T22:47:14Z

Briward:

== Cisco Unity Connection API List Examples ==

=== Examples for /vmrest/version ===

==== Example 1: GET====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/version</pre>

HTTP RESPONSE:
<pre>
<VersionInformation>
<name>vmrest</name>
<version>8.6.2.0ES3</version>
</VersionInformation>
</pre>

=== Examples for /vmrest/distributionlist ===

==== Example 1: GET ====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</URI>
<ObjectId>92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</ObjectId>
<Alias>undeliverablemessages</Alias>
<DisplayName>Undeliverable Messages</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2092fa35cc-a72e-4f59-83e5-ccf6fce07f1e)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a</URI>
<ObjectId>24f444c9-34ce-4072-9270-672933c7bb3a</ObjectId>
<Alias>allvoicemailusers</Alias>
<DisplayName>All Voice Mail Users</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>99991</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2024f444c9-34ce-4072-9270-672933c7bb3a)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

==== Example 2: GET ====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlists?query=(alias startswith F)&sort=(alias desc)</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</URI>
<ObjectId>de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</ObjectId>
<Alias>FSTDK02</Alias>
<DisplayName>FSTDK02</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>4445</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20de9cb6c5-873c-454b-8fd3-58b7aaf62dd0)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180</URI>
<ObjectId>d3e0c786-0be4-4b72-a27b-c745d1504180</ObjectId>
<Alias>FSTDK01</Alias>
<DisplayName>FSTDK01</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>4444</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20d3e0c786-0be4-4b72-a27b-c745d1504180)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

==== Example 3: POST ====

HTTP POST:
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>

HTTP BODY:
<pre>
<DistributionList>
<Alias>FSTDK03</Alias>
<DisplayName>FSTDK03</DisplayName>
<DtmfAccessId>4446</DtmfAccessId>
</DistributionList>
</pre>

HTTP RESPONSE:
<pre>
/vmrest/distributionlists/5f038b49-5840-4974-b555-fadfaa327024
</pre>

==== Example 4:PUT ====

HTTP PUT:
<pre>https://10.10.10.10:8443/vmrest/distributionlists/{objectid}</pre>

HTTP BODY:
<pre>
<DistributionList>
<DtmfAccessId>4447</DtmfAccessId>
</DistributionList>
</pre>

HTTP RESPONSE:
<pre>
{empty response} Return Code = HTTP/1.1 204 No Content
</pre>

Cisco Unity Connection API List Examples

2012-02-21T22:46:20Z

Briward:

== Cisco Unity Connection API List Examples ==

=== Examples for /vmrest/version ===

==== Example 1 ====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/version</pre>

HTTP RESPONSE:
<pre>
<VersionInformation>
<name>vmrest</name>
<version>8.6.2.0ES3</version>
</VersionInformation>
</pre>

=== Examples for /vmrest/distributionlist ===

==== Example 1 ====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</URI>
<ObjectId>92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</ObjectId>
<Alias>undeliverablemessages</Alias>
<DisplayName>Undeliverable Messages</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2092fa35cc-a72e-4f59-83e5-ccf6fce07f1e)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a</URI>
<ObjectId>24f444c9-34ce-4072-9270-672933c7bb3a</ObjectId>
<Alias>allvoicemailusers</Alias>
<DisplayName>All Voice Mail Users</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>99991</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2024f444c9-34ce-4072-9270-672933c7bb3a)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

==== Example 2 ====

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlists?query=(alias startswith F)&sort=(alias desc)</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</URI>
<ObjectId>de9cb6c5-873c-454b-8fd3-58b7aaf62dd0</ObjectId>
<Alias>FSTDK02</Alias>
<DisplayName>FSTDK02</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>4445</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20de9cb6c5-873c-454b-8fd3-58b7aaf62dd0)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180</URI>
<ObjectId>d3e0c786-0be4-4b72-a27b-c745d1504180</ObjectId>
<Alias>FSTDK01</Alias>
<DisplayName>FSTDK01</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>4444</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%20d3e0c786-0be4-4b72-a27b-c745d1504180)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

==== Example 3 ====

HTTP POST:
<pre>https://10.10.10.10:8443/vmrest/distributionlists</pre>

HTTP BODY:
<pre>
<DistributionList>
<Alias>FSTDK03</Alias>
<DisplayName>FSTDK03</DisplayName>
<DtmfAccessId>4446</DtmfAccessId>
</DistributionList>
</pre>

HTTP RESPONSE:
<pre>
/vmrest/distributionlists/5f038b49-5840-4974-b555-fadfaa327024
</pre>

==== Example 4 ====

HTTP PUT:
<pre>https://10.10.10.10:8443/vmrest/distributionlists/{objectid}</pre>

HTTP BODY:
<pre>
<DistributionList>
<DtmfAccessId>4447</DtmfAccessId>
</DistributionList>
</pre>

HTTP RESPONSE:
<pre>
{empty response} Return Code = HTTP/1.1 204 No Content
</pre>

Cisco Unity Connection API List Examples

2012-02-21T22:40:40Z

Briward:

Cisco Unity Connection API List Examples

2012-02-21T22:04:34Z

Briward:

Cisco Unity Connection API List Examples

2012-02-16T22:31:06Z

Briward:

Cisco Unity Connection API List Examples

2012-02-16T22:26:50Z

Briward:

== Cisco Unity Connection API List Examples ==

Examples for /vmrest/version

== Example 1 ==

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/version</pre>

HTTP RESPONSE:
<pre>
<VersionInformation>
<name>vmrest</name>
<version>8.6.2.0ES3</version>
</VersionInformation>
</pre>

Examples for /vmrest/distributionlist

== Example 1 ==

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlist</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</URI>
<ObjectId>92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</ObjectId>
<Alias>undeliverablemessages</Alias>
<DisplayName>Undeliverable Messages</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2092fa35cc-a72e-4f59-83e5-ccf6fce07f1e)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a</URI>
<ObjectId>24f444c9-34ce-4072-9270-672933c7bb3a</ObjectId>
<Alias>allvoicemailusers</Alias>
<DisplayName>All Voice Mail Users</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>99991</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2024f444c9-34ce-4072-9270-672933c7bb3a)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

Cisco Unity Connection API List Examples

2012-02-16T22:26:33Z

Briward:

== Cisco Unity Connection API List Examples ==

Examples for /vmrest/version

== Example 1 ==

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/version</pre>

HTTP RESPONSE:
<pre>
<VersionInformation>
<name>vmrest</name>
<version>8.6.2.0ES3</version>
</VersionInformation>
</pre>

Examples for /vmrest/distributionlist/b>

== Example 1 ==

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/distributionlist</pre>

HTTP RESPONSE:
<pre>
<DistributionLists total="2">
<DistributionList>
<URI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</URI>
<ObjectId>92fa35cc-a72e-4f59-83e5-ccf6fce07f1e</ObjectId>
<Alias>undeliverablemessages</Alias>
<DisplayName>Undeliverable Messages</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2092fa35cc-a72e-4f59-83e5-ccf6fce07f1e)</AlternateNamesURI>
</DistributionList>
<DistributionList>
<URI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a</URI>
<ObjectId>24f444c9-34ce-4072-9270-672933c7bb3a</ObjectId>
<Alias>allvoicemailusers</Alias>
<DisplayName>All Voice Mail Users</DisplayName>
<LocationObjectId>3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationObjectId>
<LocationURI>/vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9</LocationURI>
<DtmfAccessId>99991</DtmfAccessId>
<PartitionObjectId>e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionObjectId>
<PartitionURI>/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd</PartitionURI>
<DistributionListMembersURI>/vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a/distributionlistmembers</DistributionListMembersURI>
<AlternateNamesURI>/vmrest/alternatenames?query=(DistributionListObjectId%20is%2024f444c9-34ce-4072-9270-672933c7bb3a)</AlternateNamesURI>
</DistributionList>
</DistributionLists>
</pre>

Cisco Unity Connection API List

2012-02-16T22:23:43Z

Briward:

Cisco Unity Connection API List

2012-02-16T22:22:20Z

Briward:

Cisco Unity Connection API List

2012-02-16T22:06:49Z

Briward:

DRAFT

{| width="85%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/version
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to retrieve the current version of the system.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <nowiki>https://<host>:<port>/vmrest/version</nowiki>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Successful Response Schema:'''
| style="width: 60%;"|
<pre>
<xs:schema elementFormDefault="qualified">
<xs:complexType name="VersionInformation">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="version" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:element name="VersionInformation" type="VersionInformation"/>
</xs:schema>
</pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| [[Cisco_Unity_Connection_API_List_Examples|Example]]
|}

Cisco Unity Connection API List Examples

2012-02-16T17:37:31Z

Briward:

Cisco Unity Connection API List Examples

2012-02-16T17:37:07Z

Briward: /* Cisco Unity Connection API List Examples */

== Cisco Unity Connection API List Examples ==

Examples for /vmrest/version
Example 1

HTTP GET:
<pre>https://10.10.10.10:8443/vmrest/version</pre>

HTTP RESPONSE:
<pre>
<VersionInformation>
<name>vmrest</name>
<version>8.6.2.0ES3</version>
</VersionInformation>
</pre>

Cisco Unity Connection API List Examples

2012-02-16T17:34:13Z

Briward: Created page with "== Cisco Unity Connection API List Examples =="

== Cisco Unity Connection API List Examples ==

Cisco Unity Connection API List

2012-02-16T17:33:25Z

Briward:

DRAFT

{| width="85%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/version
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to retrieve the current version of the APIs running on the system.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <nowiki>https://<host>:<port>/vmrest/version</nowiki>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Successful Response Schema:'''
| style="width: 60%;"|
<pre>
<xs:schema elementFormDefault="qualified">
<xs:complexType name="VersionInformation">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="version" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:element name="VersionInformation" type="VersionInformation"/>
</xs:schema>
</pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| [[Cisco_Unity_Connection_API_List_Examples|Example]]
|}

Cisco Unity Connection API List

2012-02-10T00:31:07Z

Briward:

DRAFT

{| width="85%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/version
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to retrieve the current version of the APIs running on the system.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <nowiki>https://<host>:<port>/vmrest/version</nowiki>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML, JSON
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Successful Response Schema:'''
| style="width: 60%;"|
<pre>
<xs:schema elementFormDefault="qualified">
<xs:complexType name="VersionInformation">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="version" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:element name="VersionInformation" type="VersionInformation"/>
</xs:schema>
</pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| None.
|}

Cisco Unity Connection API List

2012-02-09T23:55:39Z

Briward:

DRAFT

{| width="85%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/version
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to retrieve the current version of the APIs running on the system.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <nowiki>https://<host>:<port>/vmrest/version</nowiki>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML, JSON
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Successful Response Schema:'''
| style="width: 60%;"|
<pre>
<xs:schema elementFormDefault="qualified">
<xs:complexType name="VersionInformation">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="version" type="xs:string"/>
</xs:sequence></xs:complexType>
<xs:element name="VersionInformation" type="VersionInformation"/>
</xs:schema>
</pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| None.
|}

Cisco Unity Connection API List

2012-02-09T23:55:15Z

Briward: Created page with "{| width="85%" cellpadding="5%" cellspacing="0" border="1" | colspan="2" | /vmrest/version |- | style="width: 25%;"| '''De..."

{| width="85%" cellpadding="5%" cellspacing="0" border="1"
| colspan="2" | /vmrest/version
|-
| style="width: 25%;"| '''Description:'''
| style="width: 60%;"| Use this API to retrieve the current version of the APIs running on the system.
|-
| style="width: 25%;"| '''API URI:'''
| style="width: 60%;"| <nowiki>https://<host>:<port>/vmrest/version</nowiki>
|-
| style="width: 25%;"| '''Supported Response Formats:'''
| style="width: 60%;"| XML, JSON
|-
| style="width: 25%;"| '''HTTP Method:'''
| style="width: 60%;"| GET
|-
| style="width: 25%;"| '''Request Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Header Parameters:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Parameter Description:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Successful Response Schema:'''
| style="width: 60%;"|
<pre>
<xs:schema elementFormDefault="qualified">
<xs:complexType name="VersionInformation">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="version" type="xs:string"/>
</xs:sequence></xs:complexType>
<xs:element name="VersionInformation" type="VersionInformation"/>
</xs:schema>
</pre>
|-
| style="width: 25%;"| '''Failure Response Schema:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Related Error Codes:'''
| style="width: 60%;"| See API Response Codes.
|-
| style="width: 25%;"| '''Events Triggered:'''
| style="width: 60%;"| None.
|-
| style="width: 25%;"| '''Release:'''
| style="width: 60%;"| 8.5(1)
|-
| style="width: 25%;"| '''Notes or Examples:'''
| style="width: 60%;"| None.
|}

Cisco Unity Connection APIs

2012-02-09T22:56:21Z

Briward: /* Other Connection API Resources */

Cisco Unity Connection is a feature-rich voice messaging platform based on the same Linux operating system as Cisco Unified Communications Manager. Connection users can access voice messages by using email, web clients, mobile devices, instant messaging, and desktop clients such as Cisco Unified Personal Communicator; and can view, search, sort, and play messages on a Cisco Unified IP Phone display. Connection also provides comprehensive automated-attendant functions, including intelligent call routing and easily customizable call screen and message notification options. For more information see [http://www.cisco.com/en/US/products/ps6509/tsd_products_support_series_home.html Cisco Unity Connection documentation on Cisco.com].

Cisco Unity Connection includes several Representational State Transfer (REST) application programming interfaces (APIs) that provide provisioning, messaging, and telephony access to Connection. These APIs provide the ability to integrate Connection features into existing enterprise-wide provisioning management systems and messaging clients.
The APIs are REST interfaces that standardize operations such as add, delete, view, and modify.

== Available Connection REST APIs ==

'''CUPI''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API]]

The Cisco Unity Connection Provisioning Interface (CUPI) API provides access to the most commonly provisioned data on Cisco Unity Connection systems—users, contacts, distribution lists, and call handlers.

'''CUPI for End Users''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_For_End_Users]]

The Cisco Unity Connection Provisioning Interface (CUPI) API includes access for individual users when authenticating against user credentials. This allows for custom end-user applications.

'''CUMI''': [[Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]

The Cisco Unity Connection Messaging Interface (CUMI) API provides access to user messages.

'''CUTI''': [[Cisco_Unity_Connection_Telephony_Interface_(CUTI)_API]]

The Cisco Unity Connection Telephony Interface (CUTI) API provides the ability to play and record audio content over the phone.

'''CUNI''': [[Cisco_Unity_Connection_Notification_Interface_(CUNI)_API]]

The Cisco Unity Connection Notification Interface (CUNI) API provides notification for one or more users. CUNI is designed for use in server-to-server applications where receiving notifications for many users over a single connection is required.

== Other Connection API Resources ==

[[Cisco_Unity_Connection_REST_API_FAQ|FAQ]]

[[Cisco_Unity_Connection_APIs_--_Troubleshooting|Troubleshooting]]

[[Cisco_Unity_Connection_API_List|Draft]]

[[Category: Unity Connection APIs]]