Cisco Unity Connection Messaging Interface (CUMI) API
From DocWiki
(→Introduction) |
|||
| (7 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | '''Links to Other API pages:''' | + | '''Links to Other API pages:''' [[Cisco Unity Connection APIs]] |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | __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 |
| - | == How the documentation is organized == | + | <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 > Advanced > API Settings page in Cisco Unity Connection Administration. |
| + | |||
| + | Note: All the above functions associated with CUMI 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].<br> | ||
| + | |||
| + | 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. | ||
| + | |||
| + | == 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]] <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]] | ||
| + | |||
| + | === 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)]] | [[Cisco Unity Connection Messaging Interface (CUMI) API -- Preventing Messages from Being Automatically Deleted (Investigative Hold)|Preventing Messages from Being Deleted (Investigative Hold)]] | ||
| - | |||
| - | |||
| - | CUMI | + | === Samples === |
| + | |||
| + | [[Cisco Unity Connection Messaging Interface (CUMI) API -- HTTP Samples|HTTP Samples]] <br> [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. | ||
| - | + | <br> | |
| - | + | == 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. | ||
| - | + | <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: | + | [[Category:Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]] |
Revision as of 10:39, 27 November 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.
Note: All the above functions associated with CUMI 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/9x/upgrade/guide/9xcucrug051.html.
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.
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
- Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 and later
- For detailed hardware requirements, see the 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 CUMI forum on CDN.
Troubleshooting
See the following for information on troubleshooting all Connection APIs:
