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

Anilve at 18:47, 6 March 2012

2012-03-06T18:47:49Z

← Older revision		Revision as of 18:47, 6 March 2012
Line 69:		Line 69:
	</pre>		</pre>

-	A PUT API call can on Messages in the Inbox folder can update the Subject on the Messages. No other parameter on a message can be changed:	+	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>		<pre>
	PUT /vmrest/messages/<messageid>		PUT /vmrest/messages/<messageid>

Anilve: /* Mailbox Folder Operations */

2012-03-05T07:42:22Z

Mailbox Folder Operations

← Older revision		Revision as of 07:42, 5 March 2012
Line 80:		Line 80:
	<pre>		<pre>
	DELETE /vmrest/messages/<message-id>		DELETE /vmrest/messages/<message-id>
		+	</pre>
		+	A hard or soft delete can be forced by passing in the harddelete prarameter:
		+	<pre>
		+	DELETE /vmrest/messages/<message-id>?userobjectid=<userobjectid>&harddelete=<true or false>
	</pre>		</pre>

Line 106:		Line 110:
	<pre>		<pre>
	DELETE /vmrest/messages/<message-id>		DELETE /vmrest/messages/<message-id>
		+	</pre>
		+	A hard or soft delete can be forced by passing in the harddelete prarameter:
		+	<pre>
		+	DELETE /vmrest/messages/<message-id>?userobjectid=<userobjectid>&harddelete=<true or false>
	</pre>		</pre>

Anilve: /* Mailbox Folder Operations */

2012-03-05T07:37:33Z

Mailbox Folder Operations

← Older revision		Revision as of 07:37, 5 March 2012
Line 57:		Line 57:

	=== Inbox Folder Operations ===		=== 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:		A GET API call on the folder returns a message list:
	<pre>		<pre>
Line 80:		Line 83:

	=== Sent Items Folder Operations ===		=== 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:		A GET API call on the folder returns a message list:
	<pre>		<pre>
Line 103:		Line 109:

	=== Deleted Items Folder Operations ===		=== 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:		A GET API call on the folder returns a message list:
	<pre>		<pre>

Anilve: /* Mailbox Folder Operations */

2012-03-05T07:29:20Z

Mailbox Folder Operations

← Older revision		Revision as of 07:29, 5 March 2012
Line 60:		Line 60:
	<pre>		<pre>
	GET /vmrest/mailbox/folders/inbox/messages		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>

Line 79:		Line 83:
	<pre>		<pre>
	GET /vmrest/mailbox/folders/sent/messages		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>		</pre>

Line 98:		Line 106:
	<pre>		<pre>
	GET /vmrest/mailbox/folders/deleted/messages		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>		</pre>

Line 117:		Line 129:
	POST /vmrest/mailbox/folders/deleted/messages?method=empty		POST /vmrest/mailbox/folders/deleted/messages?method=empty
	</pre>		</pre>
-
-
-	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.

	=== Offset and Limit ===		=== Offset and Limit ===

Anilve: /* Mailbox Folder Operations */

2012-03-05T07:22:51Z

Mailbox Folder Operations

← Older revision		Revision as of 07:22, 5 March 2012
Line 118:		Line 118:
	</pre>		</pre>

-	~~HTTP requests for Messages differ by folder, so they are listed here separately for each folder:~~
-
-	~~<br>~~
-
-	~~{\| border="1" cellspacing="0" cellpadding="5" align="center"~~
-	\|-
-	~~! Folder~~
-	~~! Request~~
-	~~! Description~~
-	\|-
-	~~\| inbox/messages~~
-	~~\| GET~~
-	~~\| Returns read and unread messages that are not drafts or deleted messages.~~
-	\|-
-	~~\| 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.		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.

Anilve: /* Deleted Items Folder Operations */

2012-03-05T07:09:19Z

Deleted Items Folder Operations

← Older revision		Revision as of 07:09, 5 March 2012
Line 111:		Line 111:
	<pre>		<pre>
	DELETE /vmrest/messages/<message-id>		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>
		+	POST /vmrest/mailbox/folders/deleted/messages?method=empty
	</pre>		</pre>

Line 168:		Line 173:
	\|}		\|}

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

	=== Offset and Limit ===		=== Offset and Limit ===

Anilve at 07:06, 5 March 2012

2012-03-05T07:06:23Z

← Older revision		Revision as of 07:06, 5 March 2012
Line 93:		Line 93:
	DELETE /vmrest/messages/<message-id>		DELETE /vmrest/messages/<message-id>
	</pre>		</pre>
		+
	=== Deleted Items Folder Operations ===		=== Deleted Items Folder Operations ===
	A GET API call on the folder returns a message list:		A GET API call on the folder returns a message list:
Line 105:		Line 106:
	<Subject>New subject</Subject>		<Subject>New subject</Subject>
	</Message>		</Message>
		+	</pre>
		+
		+	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>		</pre>

Anilve at 07:01, 5 March 2012

2012-03-05T07:01:44Z

← Older revision		Revision as of 07:01, 5 March 2012
Line 62:		Line 62:
	</pre>		</pre>

-	A PUT API call can ~~be used~~ on Messages in the Inbox folder to update the Subject on the Messages. No other parameter on a message can be changed:	+	A PUT API call can on Messages in the Inbox folder can update the Subject on the Messages. No other parameter on a message can be changed:
	<pre>		<pre>
	PUT /vmrest/messages/<messageid>		PUT /vmrest/messages/<messageid>
Line 68:		Line 68:
	<Subject>New subject</Subject>		<Subject>New subject</Subject>
	</Message>		</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>
		+	DELETE /vmrest/messages/<message-id>
	</pre>		</pre>

Line 76:		Line 81:
	</pre>		</pre>

-	A PUT API call ~~can be used~~ on Messages in the Sent Items folder to update the Subject on the Messages. No other parameter on a message can be changed:	+	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>		<pre>
	PUT /vmrest/messages/<messageid>		PUT /vmrest/messages/<messageid>
Line 84:		Line 89:
	</pre>		</pre>

		+	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.
		+	<pre>
		+	DELETE /vmrest/messages/<message-id>
		+	</pre>
	=== Deleted Items Folder Operations ===		=== Deleted Items Folder Operations ===
	A GET API call on the folder returns a message list:		A GET API call on the folder returns a message list:

Anilve at 06:53, 5 March 2012

2012-03-05T06:53:40Z

← Older revision		Revision as of 06:53, 5 March 2012
Line 49:		Line 49:
	<br>		<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>~~<~~Folder~~> ~~	+	<pre>
		+	<Folder>
	<DisplayName></DisplayName>		<DisplayName></DisplayName>
	<MessageCount></MessageCount>		<MessageCount></MessageCount>
-	~~<~~/Folder~~>~~	+	</Folder>
	</pre>		</pre>

Line 59:		Line 60:
	<pre>		<pre>
	GET /vmrest/mailbox/folders/inbox/messages		GET /vmrest/mailbox/folders/inbox/messages
		+	</pre>
		+
		+	A PUT API call can be used on Messages in the Inbox 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>		</pre>

Line 65:		Line 74:
	<pre>		<pre>
	GET /vmrest/mailbox/folders/sent/messages		GET /vmrest/mailbox/folders/sent/messages
		+	</pre>
		+
		+	A PUT API call can be used on Messages in the Sent 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>		</pre>

Line 73:		Line 90:
	</pre>		</pre>

-	~~Doing a GET~~ on ~~<~~folder~~>/messages returns~~ a message ~~list~~:	+	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>~~<Messages>~~	+	<pre>
-	~~<Message> ~~	+	PUT /vmrest/messages/<messageid>
-	~~... ~~	+	<Message>
-	~~<~~/~~Message> ~~	+	<Subject>New subject</Subject>
-	~~<~~Message~~> ~~	+	</Message>
-	~~... ~~	+	</pre>
-	~~<~~/Message~~> ~~	+
-	~~...</Messages>~~	+
-	</pre>	+
	HTTP requests for Messages differ by folder, so they are listed here separately for each folder:		HTTP requests for Messages differ by folder, so they are listed here separately for each folder:

Anilve at 06:39, 5 March 2012

2012-03-05T06:39:26Z

← Older revision		Revision as of 06:39, 5 March 2012
Line 55:		Line 55:
	</pre>		</pre>

-	=== ~~Folder -~~ Inbox Operations ===	+	=== Inbox Folder Operations ===
	A GET API call on the folder returns a message list:		A GET API call on the folder returns a message list:
	<pre>		<pre>
Line 61:		Line 61:
	</pre>		</pre>

-	=== ~~Folder -~~ Sent Items Operations ===	+	=== Sent Items Folder Operations ===
	A GET API call on the folder returns a message list:		A GET API call on the folder returns a message list:
	<pre>		<pre>
Line 67:		Line 67:
	</pre>		</pre>

-	=== ~~Folder -~~ Deleted Items Operations ===	+	=== Deleted Items Folder Operations ===
	A GET API call on the folder returns a message list:		A GET API call on the folder returns a message list:
	<pre>		<pre>

← Older revision		Revision as of 07:22, 5 March 2012
Line 118:		Line 118:
	</pre>		</pre>

-	~~HTTP requests for Messages differ by folder, so they are listed here separately for each folder:~~
-
-	~~<br>~~
-
-	~~{\| border="1" cellspacing="0" cellpadding="5" align="center"~~
-	\|-
-	~~! Folder~~
-	~~! Request~~
-	~~! Description~~
-	\|-
-	~~\| inbox/messages~~
-	~~\| GET~~
-	~~\| Returns read and unread messages that are not drafts or deleted messages.~~
-	\|-
-	~~\| 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.		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.