DocWiki - User contributions [en]

Cisco Unity Connection Messaging Interface (CUMI) API

2012-07-23T19:45:06Z

Lindborg: /* Samples */

'''Links to Other API pages:''' [[Cisco Unity Connection APIs]]

__TOC__

 

== Introduction ==

The Cisco Unity Connection Messaging Interface (CUMI) is a messaging API for Cisco Unity Connection that has been designed to be stable and simple to use. It is based on leading industry standards for web-based API development, and provides access to a wide set of Connection messaging functionality.

If you are a customer or developer who needs the ability to integrate Connection into an existing enterprise-wide portal, CUMI offers a secure method for doing the following:

*Sending messages
*Receiving messages
*Replying to messages
*Sending broadcast messages (provided the user account is enabled to send broadcast messages)
*Sending dispatch messages
*Receiving notifications of new messages

'''Note''': By default, API access to playback secure messages is turned off. To enable API access to secure messages, check the Allow Access to Secure Message Recordings Through the Cisco Unity Connection Messaging Interface (CUMI) setting on the System Settings > Advanced > API Settings page in Cisco Unity Connection Administration.

== How the documentation is organized ==

=== Accessing Mailboxes and Folders ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API|Using the CUMI API for Mailboxes & Folders]]

=== Sending Messages using the API ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Messages|Using the CUMI API for Sending Messages]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- Sending a Voice Message with One or More Attachments|Sending a Voice Message with One or More Attachments]]

=== Working with Notifications ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Notifications|Using the CUMI API for Sending Notifications]]

=== Working with Dispatch Messages ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Dispatch Message Operations|Using the CUMI API for Dispatch Messages ]]

=== Working with Broadcast Messages ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Broadcast Messages|Using the CUMI API for Broadcast Messages]]

=== Special Features ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Preventing Messages from Being Automatically Deleted (Investigative Hold)|Preventing Messages from Being Deleted (Investigative Hold)]]

=== Samples ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- HTTP Samples|HTTP Samples]] [http://www.ciscounitytools.com/Applications/CxN/BroadcastMessageManager/BroadcastMessageManager.html Broadcast Message Tool]

== Technical Details ==

CUMI is a REST interface that standardizes operations such as add, delete, and modify. The XML comes with standard XML schema definitions that are annotated with information about what is in them.

As a web-based interface, CUMI is independent of operating system and programming language and does not require any client libraries to use.

 

== Getting started ==

In order to begin developing with the Cisco Unity Connection CUMI API, you will need to obtain the following:

=== Hardware ===

*Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 and later
*For detailed hardware requirements, see the [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/supported_platforms/8xcucspl.html Cisco Unity Connection 8.x Supported Platforms List]

=== Software ===

*Cisco Unity Connection Software Ordering
*Not for Resale Kits (Must be eligible to purchase)
*Select Unified Communications System Release Kit

Discounts for some of the required hardware and software may be available for participants in the Cisco Technology Developer Program.

We recommend that all developers have an up-to-date Cisco Developer Services support agreement. This provides the developer with access to professional support and assistance for application development.

 

== Other CUMI Resources ==

Additional information about CUMI is also available on the Cisco Developer Network (http://developer.cisco.com/web/cuc/ link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUMI.

To participate in the CUMI forum, see the [http://developer.cisco.com/web/cumi/forums CUMI forum on CDN].

 

== Troubleshooting ==

See the following for information on troubleshooting all Connection APIs:

[[Cisco Unity Connection APIs -- Troubleshooting|Troubleshooting (applies to all Connection APIs)]]

[[Category:Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- .NET 4.0 Class Library

2012-02-05T17:21:36Z

Lindborg: /* .NET 4.0 CUPI Class Library */

Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users

2012-02-05T17:18:21Z

Lindborg: /* Other CUPI Resources */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI for End Users Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Basics, Voice Name, Greetings |Basics, Voice Name, Greetings ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Unified Messaging Accounts |Unified Messaging Accounts ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Alternate Devices |Alternate Devices ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Directory |Directory ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Enabling and Disabling Greetings |Enabling and Disabling Greetings ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Location |Location ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Private Lists |Private Lists ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- SMTP Proxy Addresses |SMTP Proxy Addresses ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- System Configuration |System Configuration ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Transfer Options |Transfer Options ]]
|}

__TOC__

== Introduction ==

Cisco Unity Connection Provisioning Interface (CUPI) for End Users is a provisioning API for Cisco Unity Connection that has been designed to be stable and simple to use. It is based on leading industry standards for web-based API development, and provides access to many of the end user's account settings.

== Benefits ==

By using CUPI, end users can do the following:

* Update transfer options (basic transfer rules), unified messaging account passwords (Connection 8.5 and later), external services account passwords (Connection 8.0), and user passwords and PINs

* Record greetings and voice names

* Create, read, update, and delete private lists and private list members, alternate names, and user-defined alternate extensions

* Read SMTP proxy addresses. basic user information (for example, alias, display name, and DTMF access ID), class of service information, and administrator-defined alternate extensions

== Technical Details ==

Previous provisioning APIs required knowledge of the underlying database, and were vulnerable to changes in the database schema. CUPI provides a layer over the database to make the interface more stable.

CUPI is standards based. CUPI was developed by using the latest advances in web-based interfaces. It is a REST interface that standardizes operations such as add, delete, and modify. The XML comes with standard XML schema definitions that are annotated with information about what is in them.

Other product groups in VTG are developing REST-based interfaces, and as the interfaces converge this positions CUPI well to fit in with them. REST interfaces also work well with Web 2.0 applications.

As a web-based interface, CUPI is independent of operating system and programming language and does not require any client libraries to use.

== Getting Started ==

In order to begin developing with the Cisco Unity Connection CUPI API, you need to obtain the following:

=== Hardware ===

* Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 and later
* For detailed hardware requirements, see the [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/supported_platforms/8xcucspl.html Cisco Unity Connection 8.x Supported Platforms List]

=== Software ===

* Cisco Unity Connection Software Ordering
* Not for Resale Kits (Must be eligible to purchase)
* Communications System Release Kit

Discounts for some of the required hardware and software may be available for participants in the Cisco Technology Developer Program.

We recommend that all developers have an up-to-date Cisco Developer Services support agreement. This provides the developer with access to professional support and assistance for application development.

== Other CUPI Resources ==

Additional information about CUPI is also available on the Cisco Developer Network ([http://developer.cisco.com/web/cupi/home link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUPI.

To participate in the CUPI forum, see the [http://developer.cisco.com/web/cupi/forums CUPI forum on CDN].

On the CUPI page on CDN, you will also find links to the CUPI WADL and CUPI XML schema.

'''.NET 4.0 CUPI for Users Class Library'''
The Connection CUPI For Users class library contains a number of items that can make your .NET 4.0 applications much easier and cleaner to implement using CUPI to talk to the Connection directory. This library was used in creating the iPhone Connection CoPilot application and can be used on Windows, iOS, Android and Linux using Mono. Full source code and training videos for the library can be found on its home page here: [http://www.ciscounitytools.com/CodeSamples/Connection/CUPIForUsers/CUPIForUsers.html CUPI .NET Library Home]

== Troubleshooting ==

See the following for information on troubleshooting all Connection APIs:

[[Cisco Unity Connection APIs -- Troubleshooting |Troubleshooting (applies to all Connection APIs)]]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API For End Users]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users

2012-02-05T17:17:34Z

Lindborg: /* Other CUPI Resources */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI for End Users Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Basics, Voice Name, Greetings |Basics, Voice Name, Greetings ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Unified Messaging Accounts |Unified Messaging Accounts ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Alternate Devices |Alternate Devices ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Directory |Directory ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Enabling and Disabling Greetings |Enabling and Disabling Greetings ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Location |Location ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Private Lists |Private Lists ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- SMTP Proxy Addresses |SMTP Proxy Addresses ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- System Configuration |System Configuration ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Transfer Options |Transfer Options ]]
|}

__TOC__

== Introduction ==

Cisco Unity Connection Provisioning Interface (CUPI) for End Users is a provisioning API for Cisco Unity Connection that has been designed to be stable and simple to use. It is based on leading industry standards for web-based API development, and provides access to many of the end user's account settings.

== Benefits ==

By using CUPI, end users can do the following:

* Update transfer options (basic transfer rules), unified messaging account passwords (Connection 8.5 and later), external services account passwords (Connection 8.0), and user passwords and PINs

* Record greetings and voice names

* Create, read, update, and delete private lists and private list members, alternate names, and user-defined alternate extensions

* Read SMTP proxy addresses. basic user information (for example, alias, display name, and DTMF access ID), class of service information, and administrator-defined alternate extensions

== Technical Details ==

Previous provisioning APIs required knowledge of the underlying database, and were vulnerable to changes in the database schema. CUPI provides a layer over the database to make the interface more stable.

CUPI is standards based. CUPI was developed by using the latest advances in web-based interfaces. It is a REST interface that standardizes operations such as add, delete, and modify. The XML comes with standard XML schema definitions that are annotated with information about what is in them.

Other product groups in VTG are developing REST-based interfaces, and as the interfaces converge this positions CUPI well to fit in with them. REST interfaces also work well with Web 2.0 applications.

As a web-based interface, CUPI is independent of operating system and programming language and does not require any client libraries to use.

== Getting Started ==

In order to begin developing with the Cisco Unity Connection CUPI API, you need to obtain the following:

=== Hardware ===

* Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 and later
* For detailed hardware requirements, see the [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/supported_platforms/8xcucspl.html Cisco Unity Connection 8.x Supported Platforms List]

=== Software ===

* Cisco Unity Connection Software Ordering
* Not for Resale Kits (Must be eligible to purchase)
* Communications System Release Kit

Discounts for some of the required hardware and software may be available for participants in the Cisco Technology Developer Program.

We recommend that all developers have an up-to-date Cisco Developer Services support agreement. This provides the developer with access to professional support and assistance for application development.

== Other CUPI Resources ==

Additional information about CUPI is also available on the Cisco Developer Network ([http://developer.cisco.com/web/cupi/home link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUPI.

To participate in the CUPI forum, see the [http://developer.cisco.com/web/cupi/forums CUPI forum on CDN].

On the CUPI page on CDN, you will also find links to the CUPI WADL and CUPI XML schema.

'''.NET 4.0 CUPI for Users Class Library'''
The Connection CUPI For USers class library contains a number of items that can make your .NET 4.0 applications much easier and cleaner to implement using CUPI to talk to the Connection directory. This library was used in creating the iPhone Connection CoPilot application and can be used on Windows, iOS, Android and Linux using Mono. Full source code and training videos for the library can be found on its home page here: [http://www.ciscounitytools.com/CodeSamples/Connection/CUPIForUsers/CUPIForUsers.html CUPI .NET Library Home]

== Troubleshooting ==

See the following for information on troubleshooting all Connection APIs:

[[Cisco Unity Connection APIs -- Troubleshooting |Troubleshooting (applies to all Connection APIs)]]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API For End Users]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- .NET 4.0 Class Library

2011-09-09T23:40:08Z

Lindborg:

Cisco Unity Connection Provisioning Interface (CUPI) API -- .NET 4.0 Class Library

2011-09-09T23:38:59Z

Lindborg:

==== .NET 4.0 CUPI Class Library ====

The ConnectionCUPIFunctions class library contains a number of items that can make your .NET 4.0 applications much easier and cleaner to implement using CUPI to talk to the Connection directory. Full source code and training videos for the library can be found on its home page here:

[http://www.ciscounitytools.com/CodeSamples/Connection/CUPI/CUPI.html CUPI .NET Library Home]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- .NET 4.0 Class Library

2011-09-09T23:38:47Z

Lindborg:

==== .NET 4.0 CUPI Class Librar ====

The ConnectionCUPIFunctions class library contains a number of items that can make your .NET 4.0 applications much easier and cleaner to implement using CUPI to talk to the Connection directory. Full source code and training videos for the library can be found on its home page here:

[http://www.ciscounitytools.com/CodeSamples/Connection/CUPI/CUPI.html CUPI .NET Library Home]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- .NET 4.0 Class Library

2011-09-09T23:37:11Z

Lindborg:

The ConnectionCUPIFunctions class library contains a number of items that can make your .NET 4.0 applications much easier and cleaner to implement using CUPI to talk to the Connection directory. Full source code and training videos for the library can be found on its home page here:

[http://www.ciscounitytools.com/CodeSamples/Connection/CUPI/CUPI.html CUPI .NET Library Home]

Cisco Unity Connection Provisioning Interface (CUPI) API -- .NET 4.0 Class Library

2011-09-09T23:36:36Z

Lindborg: New page: The ConnectionCUPIFunctions class library contains a number of items that can make your .NET 4.0 applications much easier and cleaner to implement using CUPI to talk to the Connection dire...

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2011-09-09T23:34:34Z

Lindborg: /* General CUPI Information */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== Listing of CUPI Documentation by Subject Matter ==

=== General CUPI Information ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Latest WADL|Getting the Latest WADL ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details|Getting the Object Schema Details ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- .NET 4.0 Class Library | .NET 4.0 Class Library ]]

=== User Account Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

=== Call Handler Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

=== System Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

== Alphabetical Index of All CUPI Documentation (by Page Title) ==

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

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

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

2011-08-27T23:18:10Z

Lindborg:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

2011-08-27T23:16:48Z

Lindborg:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

2011-08-27T23:15:24Z

Lindborg:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

2011-08-27T23:14:22Z

Lindborg:

All the schema details for all supported object types can be obtained by going to the REST schema page using the URL:

<nowiki>http:// {server name} /vmrest/schema</nowiki>

All the objects supported will come up in a list, each as a link that will take you to a page detailing which items of information will be returned when fetching that object.

NOTE: In the case of users the schema shows what will come back when fetching the full user data using a URL like this:

<nowiki>http:// {server name} /vmrest/users/{object_id}</nowiki>

If, however, you are getting a list of users or searching for one or more users with a query parameter like this:

<nowiki>http:// {server name} /vmrest/users?query=(alias%20is%20operator)</nowiki>

then you will get a subset of user properties on each user returned in the list. This is an optimization since users have such a large amount of data associated with them that returning all of those properties for each user on a potentially large list is very inefficient. Make sure your application accounts for this.

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

2011-08-27T23:13:26Z

Lindborg:

All the schema details for all supported object types can be obtained by going to the REST schema page using the URL:

http:// {server name} /vmrest/schema

All the objects supported will come up in a list, each as a link that will take you to a page detailing which items of information will be returned when fetching that object.

NOTE: In the case of users the schema shows what will come back when fetching the full user data using a URL like this:

http:// {server name} /vmrest/users/{object_id}

If, however, you are getting a list of users or searching for one or more users with a query parameter like this:

http:// {server name} /vmrest/users?query=(alias%20is%20operator)

then you will get a subset of user properties on each user returned in the list. This is an optimization since users have such a large amount of data associated with them that returning all of those properties for each user on a potentially large list is very inefficient. Make sure your application accounts for this.

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

2011-08-27T23:11:10Z

Lindborg:

All the schema details for all supported object types can be obtained by going to the REST schema page using the URL:

http://{server_name}/vmrest/schema

All the objects supported will come up in a list, each as a link that will take you to a page detailing which items of information will be returned when fetching that object.

NOTE: In the case of users the schema shows what will come back when fetching the full user data using a URL like this:

http://{server_name}/vmrest/users/{object_id}

If, however, you are getting a list of users or searching for one or more users with a query parameter like this:

http://{server_name}/vmrest/users?query=(alias%20is%20operator)

then you will get a subset of user properties on each user returned in the list. This is an optimization since users have such a large amount of data associated with them that returning all of those properties for each user on a potentially large list is very inefficient. Make sure your application accounts for this.

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details

2011-08-27T23:09:28Z

Lindborg: New page: All the schema details for all supported object types can be obtained by going to the REST schema page using the URL: http://{server name}/vmrest/schema All the objects supported will co...

All the schema details for all supported object types can be obtained by going to the REST schema page using the URL:

http://{server name}/vmrest/schema

All the objects supported will come up in a list, each as a link that will take you to a page detailing which items of information will be returned when fetching that object.

NOTE: In the case of users the schema shows what will come back when fetching the full user data using a URL like this:

http://{server name}/vmrest/users/{object id}

If, however, you are getting a list of users or searching for one or more users with a query parameter like this:

http://{server name}/vmrest/users?query=(alias%20is%20operator)

then you will get a subset of user properties on each user returned in the list. This is an optimization since users have such a large amount of data associated with them that returning all of those properties for each user on a potentially large list is very inefficient. Make sure your application accounts for this.

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2011-08-27T23:04:47Z

Lindborg: /* General CUPI Information */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== Listing of CUPI Documentation by Subject Matter ==

=== General CUPI Information ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Latest WADL|Getting the Latest WADL ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Schema Details|Getting the Object Schema Details ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

=== User Account Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

=== Call Handler Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

=== System Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

== Alphabetical Index of All CUPI Documentation (by Page Title) ==

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

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

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection REST API FAQ

2011-08-27T23:03:24Z

Lindborg: /* How do I find out which networked cluster a user is on? */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''Connection APIs'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|CUPI Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|CUPI for End Users Overview ]] [[Cisco Unity Connection Messaging Interface (CUMI) API|CUMI Overview ]] [[Cisco Unity Connection Telephony Interface (CUTI) API|CUTI Overview ]] [[Cisco Unity Connection Notification Interface (CUNI) API|CUNI Overview ]]
|}

__TOC__

== What can cause a 415 error? ==

415 errors are generally caused by not specifying the requested content type. Try setting the "Content-Type" header to "application/xml".

== What can cause a 503 error? ==
A 503 error will result if there are too many requests queued up on the server.

The system will process a maximum of 5 web application requests at one time. The throttle uses a global variable for this, so any request in any process using the throttle will count towards 1 of the 5.

Any request that comes in while 5 or more others are processing will get queued and processed as soon as one of the active requests is complete.

We can queue up to 255 requests (or the thread limit in tomcat, which is 150).

As long as requests process at a rate of 1 request per second, the other requests will remain in the queue. If the requests start processing at a rate slower than 1 per second, the queue wait mechanism times out and the client will get a “server busy” (HTTP 503) response.

== How do I GET the guid (objectid) of a user? ==

Search by alias to get the user XML, then extract the ObjectId field. For example, to find the user John Doe with alias jdoe:

<pre>
GET http://<connection-server>/vmrest/users?query=(alias%20is%20jdoe)
</pre>

Note that some languages and/or libraries require the URL to be escaped first, in which case the spaces need to be converted to %20.

== How do I find out which networked cluster a user is on? ==

Search for the user in the global user list, and look at the user's location (LocationObjectId):

<pre>
GET http://<connection-server>/vmrest/globalusers?query=(alias%20is%20jdoe)
</pre>

== What is returned from a PUT? ==

A successful PUT operation returns an HTTP status code of 204 No Content.

All HTTP 2xx status codes mean success. Status code 204 means (quoting from RFC 2616): "The server has fulfilled the request but does not need to return an entity-body (aka content)."

A PUT operation sends a request to the server to change/update a resource, so the server does not need to send back anything except a success code, which is what 204 is appropriate for.

== Is there support for paging? ==

Yes. Paging is supported via two query parameters:

* '''rowsPerPage''': Indicates how many objects to return in a single query.
* '''pageNumber''': Indicates which page of objects to return.

For example:

<pre>
GET http://<connection-server>/vmrest/users?rowsPerPage=100&pageNumber=1
GET http://<connection-server>/vmrest/users?rowsPerPage=100&pageNumber=2
</pre>

== What causes a 302 error? ==

An HTTP 302 response is very often caused by a client trying to connect to a web application by using HTTP protocol when the web application requires HTTPS. The web server sends back a 302 response to the client in an attempt to redirect it to the secure HTTPS port.

[[Category: Unity Connection APIs]]

Cisco Unity Connection REST API FAQ

2011-08-27T23:03:02Z

Lindborg: /* How do I GET the guid (objectid) of a user? */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''Connection APIs'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|CUPI Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|CUPI for End Users Overview ]] [[Cisco Unity Connection Messaging Interface (CUMI) API|CUMI Overview ]] [[Cisco Unity Connection Telephony Interface (CUTI) API|CUTI Overview ]] [[Cisco Unity Connection Notification Interface (CUNI) API|CUNI Overview ]]
|}

__TOC__

== What can cause a 415 error? ==

415 errors are generally caused by not specifying the requested content type. Try setting the "Content-Type" header to "application/xml".

== What can cause a 503 error? ==
A 503 error will result if there are too many requests queued up on the server.

The system will process a maximum of 5 web application requests at one time. The throttle uses a global variable for this, so any request in any process using the throttle will count towards 1 of the 5.

Any request that comes in while 5 or more others are processing will get queued and processed as soon as one of the active requests is complete.

We can queue up to 255 requests (or the thread limit in tomcat, which is 150).

As long as requests process at a rate of 1 request per second, the other requests will remain in the queue. If the requests start processing at a rate slower than 1 per second, the queue wait mechanism times out and the client will get a “server busy” (HTTP 503) response.

== How do I GET the guid (objectid) of a user? ==

Search by alias to get the user XML, then extract the ObjectId field. For example, to find the user John Doe with alias jdoe:

<pre>
GET http://<connection-server>/vmrest/users?query=(alias%20is%20jdoe)
</pre>

Note that some languages and/or libraries require the URL to be escaped first, in which case the spaces need to be converted to %20.

== How do I find out which networked cluster a user is on? ==

Search for the user in the global user list, and look at the user's location (LocationObjectId):

<pre>
GET http://<connection-server>/vmrest/globalusers?query=(aliasis jdoe)
</pre>

== What is returned from a PUT? ==

A successful PUT operation returns an HTTP status code of 204 No Content.

All HTTP 2xx status codes mean success. Status code 204 means (quoting from RFC 2616): "The server has fulfilled the request but does not need to return an entity-body (aka content)."

A PUT operation sends a request to the server to change/update a resource, so the server does not need to send back anything except a success code, which is what 204 is appropriate for.

== Is there support for paging? ==

Yes. Paging is supported via two query parameters:

* '''rowsPerPage''': Indicates how many objects to return in a single query.
* '''pageNumber''': Indicates which page of objects to return.

For example:

<pre>
GET http://<connection-server>/vmrest/users?rowsPerPage=100&pageNumber=1
GET http://<connection-server>/vmrest/users?rowsPerPage=100&pageNumber=2
</pre>

== What causes a 302 error? ==

An HTTP 302 response is very often caused by a client trying to connect to a web application by using HTTP protocol when the web application requires HTTPS. The web server sends back a 302 response to the client in an attempt to redirect it to the secure HTTPS port.

[[Category: Unity Connection APIs]]

Cisco Unity Connection REST API FAQ

2011-08-27T23:01:31Z

Lindborg: /* Is there support for paging? */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''Connection APIs'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|CUPI Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|CUPI for End Users Overview ]] [[Cisco Unity Connection Messaging Interface (CUMI) API|CUMI Overview ]] [[Cisco Unity Connection Telephony Interface (CUTI) API|CUTI Overview ]] [[Cisco Unity Connection Notification Interface (CUNI) API|CUNI Overview ]]
|}

__TOC__

== What can cause a 415 error? ==

415 errors are generally caused by not specifying the requested content type. Try setting the "Content-Type" header to "application/xml".

== What can cause a 503 error? ==
A 503 error will result if there are too many requests queued up on the server.

The system will process a maximum of 5 web application requests at one time. The throttle uses a global variable for this, so any request in any process using the throttle will count towards 1 of the 5.

Any request that comes in while 5 or more others are processing will get queued and processed as soon as one of the active requests is complete.

We can queue up to 255 requests (or the thread limit in tomcat, which is 150).

As long as requests process at a rate of 1 request per second, the other requests will remain in the queue. If the requests start processing at a rate slower than 1 per second, the queue wait mechanism times out and the client will get a “server busy” (HTTP 503) response.

== How do I GET the guid (objectid) of a user? ==

Search by alias to get the user XML, then extract the ObjectId field. For example, to find the user John Doe with alias jdoe:

<pre>
GET http://<connection-server>/vmrest/users?query=(aliasis jdoe)
</pre>

Note that some languages and/or libraries require the URL to be escaped first, in which case the spaces need to be converted to %20.

== How do I find out which networked cluster a user is on? ==

Search for the user in the global user list, and look at the user's location (LocationObjectId):

<pre>
GET http://<connection-server>/vmrest/globalusers?query=(aliasis jdoe)
</pre>

== What is returned from a PUT? ==

A successful PUT operation returns an HTTP status code of 204 No Content.

All HTTP 2xx status codes mean success. Status code 204 means (quoting from RFC 2616): "The server has fulfilled the request but does not need to return an entity-body (aka content)."

A PUT operation sends a request to the server to change/update a resource, so the server does not need to send back anything except a success code, which is what 204 is appropriate for.

== Is there support for paging? ==

Yes. Paging is supported via two query parameters:

* '''rowsPerPage''': Indicates how many objects to return in a single query.
* '''pageNumber''': Indicates which page of objects to return.

For example:

<pre>
GET http://<connection-server>/vmrest/users?rowsPerPage=100&pageNumber=1
GET http://<connection-server>/vmrest/users?rowsPerPage=100&pageNumber=2
</pre>

== What causes a 302 error? ==

An HTTP 302 response is very often caused by a client trying to connect to a web application by using HTTP protocol when the web application requires HTTPS. The web server sends back a 302 response to the client in an attempt to redirect it to the secure HTTPS port.

[[Category: Unity Connection APIs]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Latest WADL

2011-03-04T00:50:47Z

Lindborg: /* Getting the Latest WADL */

Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Latest WADL

2011-03-04T00:50:27Z

Lindborg: New page: '''Links to Other API pages:''' Cisco_Unity_Connection_APIs {| align="right" border="1" |align="center"|'''CUPI Guide Contents''' |- |[[Cisco Unity Connection Provisioning Interface (C...

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2011-03-04T00:43:32Z

Lindborg: /* General CUPI Information */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== Listing of CUPI Documentation by Subject Matter ==

=== General CUPI Information ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Latest WADL|Getting the Latest WADL ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

=== User Account Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

=== Call Handler Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

=== System Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

== Alphabetical Index of All CUPI Documentation (by Page Title) ==

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

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

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

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

2011-03-04T00:40:46Z

Lindborg:

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

2011-03-04T00:06:35Z

Lindborg: Removing all content from page

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

2011-03-04T00:05:49Z

Lindborg: New page: Viewing Every user with a mailbox can have private lists. To see the private lists belonging to a user, do the following GET request: GET /vmrest/users/<user object id>/privatelists/ He...

Viewing
Every user with a mailbox can have private lists. To see the private lists belonging to a user, do the following GET request:

GET /vmrest/users/<user object id>/privatelists/
Here is an example of the response you might receive to such a request:

<?xml version="1.0" encoding="UTF-8"?>
<PrivateLists total="1">
<PrivateList>
<URI>/vmrest/users/f90d26fc-0e4a-405a-8c42-189a93129bdc/
privatelists/1f443e29-1d6b-4ef8-89a6-2767549e3577</URI>
<ObjectId>1f443e29-1d6b-4ef8-89a6-2767549e3577</ObjectId>
<DisplayName>1</DisplayName>
<UserObjectId>f90d26fc-0e4a-405a-8c42-189a93129bdc</UserObjectId>
<UserURI>/vmrest/users/f90d26fc-0e4a-405a-8c42-189a93129bdc</UserURI>
<DtmfName>1</DtmfName>
<Alias>UserA_1f443e29-1d6b-4ef8-89a6-2767549e3577</Alias>
<VoiceName>6ce746b7-d775-4bc4-9d19-8b6a55b9461d.wav</VoiceName>
<VoiceFileURI>/vmrest/voicefiles/
6ce746b7-d775-4bc4-9d19-8b6a55b9461d.wav</VoiceFileURI>
<NumericId>1</NumericId>
<IsAddressable>true</IsAddressable>
</PrivateList>
</PrivateLists>
Many of these fields are consistent with what you see on other objects. Specific fields that are unique to private lists and require explanation are described below.

Private lists belong to specific users. The UserObjectId and UserURI field show that relationship.

DtmfName is a field with a value that is automatically generated every time the display name changes on the private list. DtmfName holds the digits that would need to be dialed to address a message by name to this group by phone.

Alias is a unique text name for the private list. The alias is automatically generated, and to ensure it is unique, it is constructed by concatenating the user alias, an underscore and the private list's object id. The user's alias is truncated to 28 characters to avoid overflow.

NumericId is the number of the private list. Private lists are numbered 1 through 99, and when addressing a message by extension over the phone, the number can be used to choose the group.

IsAddressable is an odd flag. It flags whether or not the private list is addressable. By default, all private lists are addressable.

[edit] Creating
The following POST creates a private list. In this example, it would be private list 2.

POST /vmrest/users/<user object id>/privatelists

<?xml version="1.0" encoding="UTF-8"?>
<PrivateList>
<DisplayName>2</DisplayName>
<VoiceName>6ce746b7-d775-4bc4-9d19-8b6a55b9461d.wav</VoiceName>
<NumericId>2</NumericId>
</PrivateList>
These are the only three parameters that can be explicitly set on a new private list. The other parameters are not allowed on a POST, either defaulting to a certain value or being auto-generated as discussed above. The ObjectId can be explicitly set if desired, but that is optional.

[edit] Updating
Only the following fields can be updated in a PUT request:

DisplayName
VoiceName
NumericId
The following example shows a PUT request that modifies some fields, changing a private list to private list 6.

PUT /vmrest/users/<user object id>/privatelists/<private list object id>

<?xml version="1.0" encoding="UTF-8"?>
<PrivateList>
<DisplayName>6</DisplayName>
<NumericId>6</NumericId>
</PrivateList>

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2011-03-04T00:05:08Z

Lindborg: /* Alphabetical Index of All CUPI Documentation (by Page Title) */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== Listing of CUPI Documentation by Subject Matter ==

=== General CUPI Information ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

=== User Account Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

=== Call Handler Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

=== System Settings ===

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

== Alphabetical Index of All CUPI Documentation (by Page Title) ==

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning|About Versioning ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Alternate Names|Alternate Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Assigning a Schedule to a Call Handler|Assigning a Schedule to a Call Handler ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Authentication and Authorization | Authentication and Authorization]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input Keys|Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings|Changing Passwords and Password Settings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions|Changing Primary and Alternate Extensions ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS) |Class of Service (COS) ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Cluster|Cluster ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values|Configuration Values ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example|Enabling Single Inbox Example ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling |Error Handling ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations|Examples of Basic Operations ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- FAQs |FAQs ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Getting the Object Count Without Getting the Objects|Getting the Object Count Without Getting the Objects ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Greetings|Greetings ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Language Map |Language Map ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform |LDAP Phone Number Transform ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Notification Devices |Notification Devices ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups and Ports|Port Groups and Ports]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private List Members | Private List Members ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Private Lists | Private Lists ]]

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

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Routing Rules |Routing Rules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Schedules |Schedules ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Searching and Sorting |Searching and Sorting ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses|SMTP Proxy Addresses ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- System Default Language and TTS Language |System Default Language and TTS Language ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Updating Caller Input Keys|Updating Caller Input Keys ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- User Import|User Import ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names |Voice Names ]]

[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Wave Formats |Wave Formats ]]

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]