Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(14 intermediate revisions not shown)
Line 1: Line 1:
-
'''Other API pages:''' [[Cisco_Unity_Connection_APIs]]
+
{| border="1" class="wikitable"
-
{| 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 for Mailboxes & Folders]]<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)]]  
+
! style="background-color: rgb(255, 215, 0);" | '''Back to:''' [[Cisco Unity Connection Messaging Interface (CUMI) API|CUMI API Overview ]]
|}
|}
-
__TOC__
+
__TOC__  
-
+
<br>
-
== About Mailboxes and Folders ==
+
 
 +
== About Mailboxes and Folders ==
The root of the Cisco Unity Connection Messaging Interface (CUMI) API is the Mailbox resource that is associated with each user. This contains some general information about the user's mailbox, and also contains a Folders resource that lists the folders for the mailbox. This list is currently fixed, although it is possible that folders may be added in the future.  
The root of the Cisco Unity Connection Messaging Interface (CUMI) API is the Mailbox resource that is associated with each user. This contains some general information about the user's mailbox, and also contains a Folders resource that lists the folders for the mailbox. This list is currently fixed, although it is possible that folders may be added in the future.  
-
Doing a GET on the Mailbox returns properties of the mailbox (for example, quotas) as well as a link to the Folders element for the mailbox:
+
Doing a GET on the Mailbox returns properties of the mailbox (for example, quotas) as well as a link to the Folders element for the mailbox:  
 +
<pre>GET /vmrest/mailbox
 +
&lt;xs:complexType name="Mailbox"&gt;
 +
&lt;xs:all&gt;
 +
&lt;xs:element name="DisplayName" type="xs:string" /&gt;
 +
&lt;xs:element name="CurrentSizeInBytes" type="xs:long" /&gt;
 +
&lt;xs:element name="IsPrimary" type="xs:boolean" /&gt;
 +
&lt;xs:element name="IsStoreMounted" type="xs:boolean" /&gt;
 +
&lt;xs:element name="IsStoreOverFlowed" type="xs:boolean" /&gt;
 +
&lt;xs:element name="IsMailboxMounted" type="xs:boolean" /&gt;
 +
&lt;xs:element name="IsWarningQuotaExceeded" type="xs:boolean" /&gt;
 +
&lt;xs:element name="IsReceiveQuotaExceeded" type="xs:boolean" /&gt;
 +
&lt;xs:element name="IsSendQuotaExceeded" type="xs:boolean" /&gt;
 +
&lt;xs:element name="WarningQuota" type="xs:long" /&gt;
 +
&lt;xs:element name="ReceiveQuota" type="xs:long" /&gt;
 +
&lt;xs:element name="SendQuota" type="xs:long" /&gt;
 +
&lt;xs:element name="IsDeletedFolderEnabled" type="xs:boolean" /&gt;
 +
&lt;xs:element name="FoldersURI" type="xs:anyURI" /&gt;
 +
&lt;/xs:all&gt;
 +
&lt;/xs:complexType&gt;
 +
</pre>
-
<pre>
+
== Mailbox Folder Operations  ==
-
GET /vmrest/mailbox
+
 
-
<xs:complexType name="Mailbox">
+
There are three Folders currently supported on a Unity Connection Mailbox -
-
<xs:all>
+
 
-
<xs:element name="DisplayName" type="xs:string" />
+
*Inbox
-
<xs:element name="CurrentSizeInBytes" type="xs:long" />
+
*Sent Items
-
<xs:element name="IsPrimary" type="xs:boolean" />
+
*Deleted Items
-
<xs:element name="IsStoreMounted" type="xs:boolean" />
+
-
<xs:element name="IsStoreOverFlowed" type="xs:boolean" />
+
-
<xs:element name="IsMailboxMounted" type="xs:boolean" />
+
-
<xs:element name="IsWarningQuotaExceeded" type="xs:boolean" />
+
-
<xs:element name="IsReceiveQuotaExceeded" type="xs:boolean" />
+
-
<xs:element name="IsSendQuotaExceeded" type="xs:boolean" />
+
-
<xs:element name="WarningQuota" type="xs:long" />
+
-
<xs:element name="ReceiveQuota" type="xs:long" />
+
-
<xs:element name="SendQuota" type="xs:long" />
+
-
<xs:element name="IsDeletedFolderEnabled" type="xs:boolean" />
+
-
<xs:element name="FoldersURI" type="xs:anyURI" />
+
-
</xs:all>
+
-
</xs:complexType>
+
-
</pre>
+
Doing a GET on the Folders returns the fixed list of folders:
Doing a GET on the Folders returns the fixed list of folders:
-
 
<pre>
<pre>
GET /vmrest/mailbox/folders
GET /vmrest/mailbox/folders
</pre>
</pre>
-
 
+
A Folder consists of a small set of properties (DisplayName and MessageCount) and a collection of Messages.
-
A '''Folder''' consists of a small set of properties (DisplayName and MessageCount) and a collection of Messages.
+
<br>
-
 
+
Doing a GET on a Folder returns a small folder resource object and a reference to its list of Messages:
Doing a GET on a Folder returns a small folder resource object and a reference to its list of Messages:
-
 
<pre>
<pre>
-
<Folder> 
+
<Folder>
-
<DisplayName></DisplayName>
+
&lt;DisplayName&gt;&lt;/DisplayName&gt;
-
<MessageCount></MessageCount>
+
&lt;MessageCount&gt;&lt;/MessageCount&gt;
</Folder>
</Folder>
 +
</pre>
 +
 +
=== Inbox Folder Operations ===
 +
All folder operations can be executed by a user when connecting with his/her credentials.
 +
When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.
 +
 +
A GET API call on the folder returns a message list:
 +
<pre>
 +
GET /vmrest/mailbox/folders/inbox/messages
 +
</pre>
 +
A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user:
 +
<pre>
 +
GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>
</pre>
</pre>
-
Doing a GET on <folder>/messages returns a message list:
+
A PUT API call can on Messages in the Inbox folder can update the Subject or the Read field on the Messages. No other parameter on a message can be changed:
 +
<pre>
 +
PUT /vmrest/messages/<messageid>
 +
<Message>
 +
    <Subject>New subject</Subject>
 +
</Message>
 +
</pre>
 +
A DELETE API call on Messages in the Inbox folder can delete the message from the folder. Whether the message is soft or hard deleted is dependent on the settings of the system.
<pre>
<pre>
-
<Messages>
+
DELETE /vmrest/messages/<message-id>
-
<Message> 
+
</pre>
-
... 
+
A hard or soft delete can be forced by passing in the harddelete prarameter:
-
</Message> 
+
<pre>
-
<Message> 
+
DELETE /vmrest/messages/<message-id>?userobjectid=<userobjectid>&harddelete=<true or false>
-
... 
+
-
</Message> 
+
-
...</Messages>
+
</pre>
</pre>
-
HTTP requests for Messages differ by folder, so they are listed here separately for each folder:
+
=== Sent Items Folder Operations ===
 +
All folder operations can be executed by a user when connecting with his/her credentials.
 +
When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.
 +
 +
A GET API call on the folder returns a message list:
 +
<pre>
 +
GET /vmrest/mailbox/folders/sent/messages
 +
</pre>
 +
A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user:
 +
<pre>
 +
GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>
 +
</pre>
 +
A PUT API call on Messages in the Sent Items folder can update the Subject on the Messages. No other parameter on a message can be changed:
 +
<pre>
 +
PUT /vmrest/messages/<messageid>
 +
<Message>
 +
    <Subject>New subject</Subject>
 +
</Message>
 +
</pre>
-
{| border="1" cellspacing="0" cellpadding="5" align="center"
+
A DELETE API call on Messages in the Sent Items folder can delete the message from the folder. Whether the message is soft or hard deleted is dependent on the settings of the system.
-
! Folder
+
<pre>
-
! Request
+
DELETE /vmrest/messages/<message-id>
-
! Description
+
</pre>
-
|-
+
A hard or soft delete can be forced by passing in the harddelete prarameter:
-
| inbox/messages
+
<pre>
-
| GET
+
DELETE /vmrest/messages/<message-id>?userobjectid=<userobjectid>&harddelete=<true or false>
-
| Returns read and unread messages that are not drafts or deleted messages.
+
</pre>
-
|-
+
-
| inbox/messages
+
-
| PUT
+
-
| Can be used to update the message subject only.
+
-
|-
+
-
| inbox/messages
+
-
| DELETE
+
-
| Depending on system settings, either removes message or moves it to the "deleted" folder.
+
-
|-
+
-
| inbox/messages
+
-
| POST?method=accept
+
-
| Causes a dispatch message to be accepted.
+
-
|-
+
-
| inbox/messages
+
-
| POST?method=reject
+
-
| Causes a dispatch message to be rejected.
+
-
|-  
+
-
| deleted/messages
+
-
| GET
+
-
| Returns list of deleted messages (if the system is set to "soft" delete - otherwise the list will always be empty).
+
-
|-
+
-
| deleted/messages
+
-
| DELETE
+
-
| Removes messages from the deleted folder (does a "hard" delete).
+
-
|-
+
-
| deleted/messages
+
-
| POST?method=empty
+
-
| Empties the deleted folder (permanently removes all messages in the folder).
+
-
|-
+
-
| deleted/messages
+
-
| POST?method=undelete
+
-
| Undeletes the specified message.
+
-
|-
+
-
| sent/messages
+
-
| GET
+
-
| Returns a list of recently sent messages.
+
-
|-
+
-
| sent/messages
+
-
| DELETE
+
-
| Deletes a message from the sent list.
+
-
|}
+
-
A '''dispatch message''' is a message that needs to go to one and only one member of a group. When the message is accepted by any one user, it is no longer available to other users. When the message is rejected by a user in the group, it is removed from the user's voicemail list.
+
=== Deleted Items Folder Operations ===
 +
All folder operations can be executed by a user when connecting with his/her credentials.
 +
When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.
 +
 +
A GET API call on the folder returns a message list:
 +
<pre>
 +
GET /vmrest/mailbox/folders/deleted/messages
 +
</pre>
 +
A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user:
 +
<pre>
 +
GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>
 +
</pre>
-
=== Offset and Limit ===
+
A PUT API call can be used on Messages in the Deleted Items folder to update the Subject on the Messages. No other parameter on a message can be changed:
 +
<pre>
 +
PUT /vmrest/messages/<messageid>
 +
<Message>
 +
    <Subject>New subject</Subject>
 +
</Message>
 +
</pre>
-
Each of the folders will accept the parameters "pagenumber" and "rowsperpage" to specify which messages to retrieve:
+
A DELETE API call on Messages in the Deleted Items folder will delete the message from the folder. This is a hard (permanent) delete.
 +
<pre>
 +
DELETE /vmrest/messages/<message-id>
 +
</pre>
 +
A POST API call on the Deleted Items folder can be used to empty the whole folder. The messages are hard deleted.
<pre>
<pre>
-
/vmrest/mailbox/folders/inbox/messages?pagenumber=1&rowsperpage=10
+
POST /vmrest/mailbox/folders/deleted/messages?method=empty
</pre>
</pre>
-
== Sorting ==
+
=== Offset and Limit  ===
-
Initially, server-side sorting will be limited to what can be done efficiently by the database, and will default to placing new messages first, followed by read messages, and sorted within each by ArrivalTime.
+
Each of the folders will accept the parameters "pagenumber" and "rowsperpage" to specify which messages to retrieve:
 +
<pre>/vmrest/mailbox/folders/inbox/messages?pagenumber=1&amp;rowsperpage=10
 +
</pre>
-
As recommended in the VTG REST guidelines, sorting will be controlled via "sortkey" and "sortorder" parameters, although initially only the following sort orders will be supported by the server:
+
== Sorting  ==
 +
 
 +
Initially, server-side sorting will be limited to what can be done efficiently by the database, and will default to placing new messages first, followed by read messages, and sorted within each by ArrivalTime.
 +
 
 +
As recommended in the VTG REST guidelines, sorting will be controlled via "sortkey" and "sortorder" parameters, although initially only the following sort orders will be supported by the server:  
{| border="1" cellspacing="0" cellpadding="5" align="center"
{| border="1" cellspacing="0" cellpadding="5" align="center"
-
! Sort Description
+
|-
 +
! Sort Description  
! Sort Parameters
! Sort Parameters
-
|-
 
-
| Newest first
 
-
| no parameters (default) or sortkey=arrivaltime&sortorder=descending
 
|-
|-
-
| Oldest first
+
| Newest first  
-
| sortkey=arrivaltime&sortorder=ascending
+
| no parameters (default) or sortkey=arrivaltime&amp;sortorder=descending
|-
|-
-
| Urgent first
+
| Oldest first
-
| sortkey=priority&sortorder=descending
+
| sortkey=arrivaltime&amp;sortorder=ascending
 +
|-
 +
| Urgent first  
 +
| sortkey=priority&amp;sortorder=descending
|}
|}
 +
<br>
-
== Filtering ==
+
== Filtering ==
-
Filtering can be done on the folders by read, priority, voice, fax and dispatch.
+
Filtering can be done on the folders by read, priority, voice, fax and dispatch.  
-
 
+
<pre>read={true|false}
-
<pre>
+
-
read={true|false}
+
priority={urgent|normal|low}
priority={urgent|normal|low}
dispatch={true|false}
dispatch={true|false}
type={voice|fax|email|receipt}
type={voice|fax|email|receipt}
-
</pre>
+
</pre>  
-
 
+
=== Examples ===
-
=== Examples ===
+
-
 
+
-
To get a list of unheard voice messages:
+
-
 
+
-
<pre>
+
-
GET /vmrest/mailbox/folders/inbox/messages?read=false&type=voice
+
-
</pre>
+
-
 
+
-
To get a list of unheard urgent messages:
+
-
 
+
-
<pre>
+
-
GET /vmrest/mailbox/folders/inbox/messages?read=false&priority=urgent
+
-
</pre>
+
-
 
+
-
To get a list of saved (deleted) messages:
+
-
 
+
-
<pre>
+
-
GET /vmrest/mailbox/folders/deleted/messages
+
-
</pre>
+
 +
To get a list of unheard voice messages:
 +
<pre>GET /vmrest/mailbox/folders/inbox/messages?read=false&amp;type=voice
 +
</pre>
 +
To get a list of unheard urgent messages:
 +
<pre>GET /vmrest/mailbox/folders/inbox/messages?read=false&amp;priority=urgent
 +
</pre>
 +
To get a list of saved (deleted) messages:
 +
<pre>GET /vmrest/mailbox/folders/deleted/messages
 +
</pre>
 +
<br>
----
----
Line 187: Line 201:
{| border="1" class="wikitable"
{| border="1" class="wikitable"
|-
|-
-
! style="background-color: rgb(255, 215, 0);" | '''Back to:''' [[Cisco Unity Connection Messaging Interface (CUMI) API|API Overview ]]
+
! style="background-color: rgb(255, 215, 0);" | '''Back to:''' [[Cisco Unity Connection Messaging Interface (CUMI) API|CUMI API Overview ]]
|}
|}
-
 
+
[[Category:Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]
-
[[Category:Cisco Unity Connection Messaging Interface (CUMI) API]]
+

Revision as of 18:47, 6 March 2012

Back to: CUMI API Overview

Contents



About Mailboxes and Folders

The root of the Cisco Unity Connection Messaging Interface (CUMI) API is the Mailbox resource that is associated with each user. This contains some general information about the user's mailbox, and also contains a Folders resource that lists the folders for the mailbox. This list is currently fixed, although it is possible that folders may be added in the future.

Doing a GET on the Mailbox returns properties of the mailbox (for example, quotas) as well as a link to the Folders element for the mailbox: 

GET /vmrest/mailbox
<xs:complexType name="Mailbox">
<xs:all>
<xs:element name="DisplayName" type="xs:string" />
<xs:element name="CurrentSizeInBytes" type="xs:long" />
<xs:element name="IsPrimary" type="xs:boolean" />
<xs:element name="IsStoreMounted" type="xs:boolean" />
<xs:element name="IsStoreOverFlowed" type="xs:boolean" />
<xs:element name="IsMailboxMounted" type="xs:boolean" />
<xs:element name="IsWarningQuotaExceeded" type="xs:boolean" />
<xs:element name="IsReceiveQuotaExceeded" type="xs:boolean" />
<xs:element name="IsSendQuotaExceeded" type="xs:boolean" />
<xs:element name="WarningQuota" type="xs:long" />
<xs:element name="ReceiveQuota" type="xs:long" />
<xs:element name="SendQuota" type="xs:long" />
<xs:element name="IsDeletedFolderEnabled" type="xs:boolean" />
<xs:element name="FoldersURI" type="xs:anyURI" />
</xs:all>
</xs:complexType>

Mailbox Folder Operations

There are three Folders currently supported on a Unity Connection Mailbox -

  • Inbox
  • Sent Items
  • Deleted Items

Doing a GET on the Folders returns the fixed list of folders: 

GET /vmrest/mailbox/folders

A Folder consists of a small set of properties (DisplayName and MessageCount) and a collection of Messages.
Doing a GET on a Folder returns a small folder resource object and a reference to its list of Messages: 

<Folder>
<DisplayName></DisplayName>
<MessageCount></MessageCount>
</Folder>

Inbox Folder Operations

All folder operations can be executed by a user when connecting with his/her credentials. When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.

A GET API call on the folder returns a message list: 

GET /vmrest/mailbox/folders/inbox/messages

A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user: 

GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>

A PUT API call can on Messages in the Inbox folder can update the Subject or the Read field on the Messages. No other parameter on a message can be changed: 

PUT /vmrest/messages/<messageid>
<Message>
     <Subject>New subject</Subject>
</Message>

A DELETE API call on Messages in the Inbox folder can delete the message from the folder. Whether the message is soft or hard deleted is dependent on the settings of the system. 

DELETE /vmrest/messages/<message-id>

A hard or soft delete can be forced by passing in the harddelete prarameter: 

DELETE /vmrest/messages/<message-id>?userobjectid=<userobjectid>&harddelete=<true or false>

Sent Items Folder Operations

All folder operations can be executed by a user when connecting with his/her credentials. When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.

A GET API call on the folder returns a message list: 

GET /vmrest/mailbox/folders/sent/messages

A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user: 

GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>

A PUT API call on Messages in the Sent Items folder can update the Subject on the Messages. No other parameter on a message can be changed: 

PUT /vmrest/messages/<messageid>
<Message>
     <Subject>New subject</Subject>
</Message>

A DELETE API call on Messages in the Sent Items folder can delete the message from the folder. Whether the message is soft or hard deleted is dependent on the settings of the system. 

DELETE /vmrest/messages/<message-id>

A hard or soft delete can be forced by passing in the harddelete prarameter: 

DELETE /vmrest/messages/<message-id>?userobjectid=<userobjectid>&harddelete=<true or false>

Deleted Items Folder Operations

All folder operations can be executed by a user when connecting with his/her credentials. When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.

A GET API call on the folder returns a message list: 

GET /vmrest/mailbox/folders/deleted/messages

A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user: 

GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>

A PUT API call can be used on Messages in the Deleted Items folder to update the Subject on the Messages. No other parameter on a message can be changed: 

PUT /vmrest/messages/<messageid>
<Message>
     <Subject>New subject</Subject>
</Message>

A DELETE API call on Messages in the Deleted Items folder will delete the message from the folder. This is a hard (permanent) delete. 

DELETE /vmrest/messages/<message-id>

A POST API call on the Deleted Items folder can be used to empty the whole folder. The messages are hard deleted. 

POST /vmrest/mailbox/folders/deleted/messages?method=empty

Offset and Limit

Each of the folders will accept the parameters "pagenumber" and "rowsperpage" to specify which messages to retrieve: 

/vmrest/mailbox/folders/inbox/messages?pagenumber=1&rowsperpage=10

Sorting

Initially, server-side sorting will be limited to what can be done efficiently by the database, and will default to placing new messages first, followed by read messages, and sorted within each by ArrivalTime.

As recommended in the VTG REST guidelines, sorting will be controlled via "sortkey" and "sortorder" parameters, although initially only the following sort orders will be supported by the server:

Sort Description Sort Parameters
Newest first no parameters (default) or sortkey=arrivaltime&sortorder=descending
Oldest first sortkey=arrivaltime&sortorder=ascending
Urgent first sortkey=priority&sortorder=descending


Filtering

Filtering can be done on the folders by read, priority, voice, fax and dispatch. 

read={true|false}
priority={urgent|normal|low}
dispatch={true|false}
type={voice|fax|email|receipt}

Examples

To get a list of unheard voice messages: 

GET /vmrest/mailbox/folders/inbox/messages?read=false&type=voice

To get a list of unheard urgent messages: 

GET /vmrest/mailbox/folders/inbox/messages?read=false&priority=urgent

To get a list of saved (deleted) messages: 

GET /vmrest/mailbox/folders/deleted/messages


Back to: CUMI API Overview

Rating: 4.0/5 (4 votes cast)

Retrieved from "http://docwiki.cisco.com/wiki/Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API_--_Using_the_CUMI_API"
Personal tools