Cisco Unity Connection Messaging Interface (CUMI) API

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m (1 revision)
(Samples)
(9 intermediate revisions not shown)
Line 1: Line 1:
-
'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
+
'''Links to Other API pages:''' [[Cisco Unity Connection APIs]]  
-
{| align="right" border="1"
+
-
|align="center"|'''CUMI Guide Contents'''
+
-
|-
+
-
|[[Cisco Unity Connection Messaging Interface (CUMI) API|API Overview ]]<br>[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API|Using the CUMI API ]]<br>[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Messages|Using the CUMI API for Sending Messages]]<br>[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Notifications|Using the CUMI API for Sending Notifications]]<br>[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Broadcast Messages|Using the CUMI API for Broadcast Messages]]<br>[[Cisco Unity Connection Messaging Interface (CUMI) API -- HTTP Samples|HTTP Samples]]<br>[[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]]<br>[[Cisco Unity Connection Messaging Interface (CUMI) API -- Preventing Messages from Being Automatically Deleted (Investigative Hold)|Preventing Messages from Being Deleted (Investigative Hold)]]  
+
-
|}
+
-
__TOC__
+
__TOC__  
 +
<br>
-
== Introduction ==
+
== 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.
+
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:
+
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
+
*Sending messages  
-
* Receiving messages
+
*Receiving messages  
-
* Replying to messages
+
*Replying to messages  
-
* Sending broadcast messages (provided the user account is enabled to send broadcast messages)
+
*Sending broadcast messages (provided the user account is enabled to send broadcast messages)  
-
* Sending dispatch messages
+
*Sending dispatch messages  
-
* Receiving notifications of new messages
+
*Receiving notifications of new messages
 +
<u>'''Note'''</u>: 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 &gt; Advanced &gt; API Settings page in Cisco Unity Connection Administration.
-
==  Technical Details ==
+
== How the documentation is organized ==
-
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.
+
=== Accessing Mailboxes and Folders  ===
-
As a web-based interface, CUMI is independent of operating system and programming language and does not require any client libraries to use.
+
[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API|Using the CUMI API for Mailboxes &amp; Folders]]
 +
=== Sending Messages using the API ===
-
==  Getting started ==
+
[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Messages|Using the CUMI API for Sending Messages]] <br> [[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]]
-
In order to begin developing with the Cisco Unity Connection CUMI API, you will need to obtain the following:
+
=== Working with Notifications  ===
-
=== Hardware ===
+
[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Notifications|Using the CUMI API for Sending Notifications]]
-
* Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 and later
+
=== Working with Dispatch Messages  ===
-
* 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 Messaging Interface (CUMI) API -- Dispatch Message Operations|Using the CUMI API for Dispatch Messages ]]
-
* Cisco Unity Connection Software Ordering
+
=== Working with Broadcast Messages  ===
-
* 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.
+
[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Broadcast Messages|Using the CUMI API for Broadcast Messages]]
-
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.
+
=== Special Features  ===
 +
[[Cisco Unity Connection Messaging Interface (CUMI) API -- Preventing Messages from Being Automatically Deleted (Investigative Hold)|Preventing Messages from Being Deleted (Investigative Hold)]]
-
== Other CUMI Resources ==
+
=== Samples  ===
-
Additional information about CUMI is also available on the Cisco Developer Network ([http://developer.cisco.com/web/cumi/home link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUMI.
+
[[Cisco Unity Connection Messaging Interface (CUMI) API -- HTTP Samples|HTTP Samples]] <br> [http://www.ciscounitytools.com/Applications/CxN/BroadcastMessageManager/BroadcastMessageManager.html Broadcast Message Tool]
-
To participate in the CUMI forum, see the [http://developer.cisco.com/web/cumi/forums CUMI forum on CDN].
+
== 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.
-
== Troubleshooting ==
+
As a web-based interface, CUMI is independent of operating system and programming language and does not require any client libraries to use.
-
See the following for information on troubleshooting all Connection APIs:
+
<br>
-
[[Cisco Unity Connection APIs -- Troubleshooting |Troubleshooting (applies to all Connection APIs)]]
+
== Getting started  ==
 +
In order to begin developing with the Cisco Unity Connection CUMI API, you will need to obtain the following:
-
[[Category:Cisco Unity Connection Messaging Interface (CUMI) API]]
+
=== 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.
 +
 
 +
<br>
 +
 
 +
== 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].
 +
 
 +
<br>
 +
 
 +
== 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]]

Revision as of 19:45, 23 July 2012

Links to Other API pages: Cisco Unity Connection APIs

Contents



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

Using the CUMI API for Mailboxes & Folders

Sending Messages using the API

Using the CUMI API for Sending Messages
Sending a Voice Message with One or More Attachments

Working with Notifications

Using the CUMI API for Sending Notifications

Working with Dispatch Messages

Using the CUMI API for Dispatch Messages

Working with Broadcast Messages

Using the CUMI API for Broadcast Messages

Special Features

Preventing Messages from Being Deleted (Investigative Hold)

Samples

HTTP Samples
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

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 CUMI forum on CDN.


Troubleshooting

See the following for information on troubleshooting all Connection APIs:

Troubleshooting (applies to all Connection APIs)

Rating: 5.0/5 (2 votes cast)

Personal tools