Cisco Unity Connection Provisioning Interface (CUPI) API - Revision history

Deeptija: /* Benefits */

2012-11-27T10:45:43Z

Benefits

← Older revision		Revision as of 10:45, 27 November 2012
Line 26:		Line 26:
	* Create, read, update, and delete contacts		* Create, read, update, and delete contacts

		+	Note: All the above functions associated with CUPI API support both the IPv4 and IPv6 addresses. However, the IPv6 address works only when Connection platform is configured in Dual (IPv4/IPv6) mode.
		+
		+	For more information see the chapter “Adding or Changing the IPv6 Addresses of Cisco Unity Connection 8.5 and Later Servers” at the following link [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/upgrade/guide/9xcucrug051.html http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/upgrade/guide/9xcucrug051.html].

	== Technical Details ==		== Technical Details ==

Deeptija: /* Introduction */

2012-11-27T10:36:37Z

Introduction

← Older revision		Revision as of 10:36, 27 November 2012
Line 13:		Line 13:

	Cisco Unity Connection Provisioning Interface (CUPI) 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 the most commonly provisioned data on Connection systems (users, contacts, distribution lists, and call handlers).		Cisco Unity Connection Provisioning Interface (CUPI) 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 the most commonly provisioned data on Connection systems (users, contacts, distribution lists, and call handlers).
		+
		+	Note: With Cisco Unity Connection 9.1(1), the single sign-on feature is enabled for all the Connection Rest APIs. For more information, see the "Single Sign-On in Cisco Unity Connection" chapter in Security Guide for Cisco Unity Connection 9.x http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/security/guide/9xcucsec061.html.

	== Benefits ==		== Benefits ==

Deeptija at 11:54, 6 February 2012

2012-02-06T11:54:22Z

← Older revision		Revision as of 11:54, 6 February 2012
Line 76:		Line 76:

	[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]		[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]
-
-	~~== New Section ==~~
-
-	~~See the following for information on troubleshooting all Connection APIs:~~
-


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

Deeptija at 11:53, 6 February 2012

2012-02-06T11:53:44Z

← Older revision		Revision as of 11:53, 6 February 2012
Line 76:		Line 76:

	[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]		[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]
		+
		+	== New Section ==
		+
		+	See the following for information on troubleshooting all Connection APIs:
		+


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

Deeptija at 11:52, 6 February 2012

2012-02-06T11:52:52Z

← Older revision		Revision as of 11:52, 6 February 2012
Line 76:		Line 76:

	[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]		[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]
-
-
-	~~== New Section ==~~
-
-	~~See the following for information on troubleshooting all Connection APIs:~~


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

Deeptija at 11:51, 6 February 2012

2012-02-06T11:51:59Z

← Older revision		Revision as of 11:51, 6 February 2012
Line 77:		Line 77:
	[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]		[[Cisco Unity Connection APIs -- Troubleshooting \|Troubleshooting (applies to all Connection APIs)]]

		+
		+	== New Section ==
		+
		+	See the following for information on troubleshooting all Connection APIs:


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

Deeptija: /* Introduction */

2012-02-06T11:49:39Z

Introduction

← Older revision		Revision as of 11:49, 6 February 2012
Line 13:		Line 13:

	Cisco Unity Connection Provisioning Interface (CUPI) 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 the most commonly provisioned data on Connection systems (users, contacts, distribution lists, and call handlers).		Cisco Unity Connection Provisioning Interface (CUPI) 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 the most commonly provisioned data on Connection systems (users, contacts, distribution lists, and call handlers).
-

	== Benefits ==		== Benefits ==

Juliew at 14:29, 14 December 2010

2010-12-14T14:29:29Z

← Older revision		Revision as of 14:29, 14 December 2010
Line 77:		Line 77:

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


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

Gscorbin: 1 revision

2010-12-14T00:05:06Z

1 revision

← Older revision

Revision as of 00:05, 14 December 2010

Juliew at 22:12, 13 December 2010

2010-12-13T22:12:44Z

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 (CUPI) API|API Overview ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== Introduction ==

Cisco Unity Connection Provisioning Interface (CUPI) 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 the most commonly provisioned data on Connection systems (users, contacts, distribution lists, and call handlers).

== Benefits ==

By using CUPI, you can securely do the following:

* Create, read, update, and delete users and user configurations
* Reset passwords
* Create, read, and update distribution lists
* Create, read, update, and delete call handlers
* Create, read, update, and delete contacts

== 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.

== CUPI Documentation ==
See the following for an index of all CUPI documentation on DocWiki:

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

== 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.

== 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]]