Cisco Unity Connection Messaging Interface (CUMI) API

From DocWiki

Revision as of 19:45, 23 July 2012 by Lindborg (Talk | contribs)
Jump to: navigation, search

Links to Other API pages: Cisco Unity Connection APIs



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)


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:



  • 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 ( 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.


See the following for information on troubleshooting all Connection APIs:

Troubleshooting (applies to all Connection APIs)

Rating: 3.0/5 (4 votes cast)

Personal tools