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

Anilve at 07:03, 1 March 2012

2012-03-01T07:03:00Z

← Older revision		Revision as of 07:03, 1 March 2012
Line 1:		Line 1:
-	~~'''Links to 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 ]]
	\|}		\|}

Line 105:		Line 103:
	</pre>		</pre>

		+
		+	----
		+	{\| border="1" class="wikitable"
		+	\|-
		+	! 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]]

Anilve at 23:35, 24 February 2012

2012-02-24T23:35:52Z

← Older revision		Revision as of 23:35, 24 February 2012
Line 3:		Line 3:
	\|align="center"\|'''CUMI Guide Contents'''		\|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)]]	+	\|[[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)]]
	\|}		\|}

Gscorbin: 1 revision

2010-12-13T23:57:07Z

1 revision

← Older revision

Revision as of 23:57, 13 December 2010

Gscorbin at 22:57, 13 December 2010

2010-12-13T22:57:58Z

New page

'''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 ]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API|Using the CUMI API ]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Messages|Using the CUMI API for Sending Messages]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Notifications|Using the CUMI API for Sending Notifications]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Broadcast Messages|Using the CUMI API for Broadcast Messages]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- HTTP Samples|HTTP Samples]] [[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]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- Preventing Messages from Being Automatically Deleted (Investigative Hold)|Preventing Messages from Being Deleted (Investigative Hold)]]
|}

__TOC__

== About Broadcast Messages ==

Broadcast messages are system-owned messages that are meant to be heard by all users. The target user is either the signed-in user or the user specified by an administrator by using the optional "userobjectid=<user object id>" parameter.

{| border="1" cellspacing="0" cellpadding="5" align="center"
! URI
! Method
! Description
|-
| mailbox/broadcastmessages
| GET
| Returns a list of broadcast messages that are active and have not yet been heard by the user.
|-
| mailbox/broadcastmessages/<message id>/voicefile
| GET
| Returns the broadcast message voice file.
|-
| mailbox/broadcastmessages/<message id>?read
| POST
| Marks the broadcast message as heard by the target user.
|-
| mailbox/broadcastmessages
| POST
| Sends a broadcast message (see below).
|}

== Sending Broadcast Messages ==

A broadcast message can be sent by a POST request to the URI noted in the table above. The content of the request is "mutipart/form-data". There must be two pieces of data in the request in the following order:

# A broadcast message in either "application/xml" or "application/json" format.
# Audio data as "audio/wav."

The only user-modifiable fields for a broadcast message are the start date, end date, and the audio content. The rest of the fields are managed internally.

=== Schema ===

<pre>
<xs:complexType name="BroadcastMessage">
<xs:all minOccurs="0">
<xs:element name="URI" type="xs:anyURI" minOccurs="0" />
<xs:element name="ObjectId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation> The primary key for this table. A globally unique, system-generated identifier for a BroadcastMessage object.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StreamFileObjectId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>StreamFileObjectId - use StreamFile instead of this column. The unique identifier of the StreamFile object
containing the name of the WAV file that is the broadcast message.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VoiceFileURI" type="xs:anyURI" minOccurs="0" />
<xs:element name="SubscriberObjectId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation> The unique identifier of the Subscriber object that sent this broadcast message.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="UserURI" type="xs:anyURI" minOccurs="0" />
<xs:element name="CreationDate" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation> The date and time when the message was created.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StartDate" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation> The date and time when the message becomes active.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EndDate" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation> The date and time when the message expires.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LastModificationSubscriberObjectId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation> The unique identifier of the subscriber that last modified the message.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LastModificationUserURI" type="xs:anyURI" minOccurs="0" />
<xs:element name="LastModificationDate" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation> The date and time the message was last modified.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StreamFile" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of audio file for this broadcast message. The name of the WAV file containing
the recorded audio (voice name, greeting, etc.) for the parent object.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>
</pre>

[[Category:Cisco Unity Connection Messaging Interface (CUMI) API]]