DocWiki - User contributions [en]

Cisco Unity Connection REST API FAQ

2010-12-15T22:16:59Z

Gscorbin:

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''Connection APIs'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|CUPI Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|CUPI for End Users Overview ]] [[Cisco Unity Connection Messaging Interface (CUMI) API|CUMI Overview ]] [[Cisco Unity Connection Telephony Interface (CUTI) API|CUTI Overview ]] [[Cisco Unity Connection Notification Interface (CUNI) API|CUNI Overview ]]
|}

__TOC__

== What can cause a 415 error? ==

415 errors are generally caused by not specifying the requested content type. Try setting the "Content-Type" header to "application/xml".

== What can cause a 503 error? ==
A 503 error will result if there are too many requests queued up on the server.

The system will process a maximum of 5 web application requests at one time. The throttle uses a global variable for this, so any request in any process using the throttle will count towards 1 of the 5.

Any request that comes in while 5 or more others are processing will get queued and processed as soon as one of the active requests is complete.

We can queue up to 255 requests (or the thread limit in tomcat, which is 150).

As long as requests process at a rate of 1 request per second, the other requests will remain in the queue. If the requests start processing at a rate slower than 1 per second, the queue wait mechanism times out and the client will get a “server busy” (HTTP 503) response.

== How do I GET the guid (objectid) of a user? ==

Search by alias to get the user XML, then extract the ObjectId field. For example, to find the user John Doe with alias jdoe:

<pre>
GET http://<connection-server>/vmrest/users?query=(aliasis jdoe)
</pre>

Note that some languages and/or libraries require the URL to be escaped first, in which case the spaces need to be converted to %20.

== How do I find out which networked cluster a user is on? ==

Search for the user in the global user list, and look at the user's location (LocationObjectId):

<pre>
GET http://<connection-server>/vmrest/globalusers?query=(aliasis jdoe)
</pre>

== What is returned from a PUT? ==

A successful PUT operation returns an HTTP status code of 204 No Content.

All HTTP 2xx status codes mean success. Status code 204 means (quoting from RFC 2616): "The server has fulfilled the request but does not need to return an entity-body (aka content)."

A PUT operation sends a request to the server to change/update a resource, so the server does not need to send back anything except a success code, which is what 204 is appropriate for.

== Is there support for paging? ==

Yes. Paging is supported via two query parameters:

* '''rowsPerPage''': Indicates how many objects to return in a single query.
* '''pageNumber''': Indicates which page of objects to return.

For example:

<pre>
GET http://<connection-server>/vmrest/users?rowsPerPage=100&page=1
GET http://<connection-server>/vmrest/users?rowsPerPage=100&page=2
</pre>

== What causes a 302 error? ==

An HTTP 302 response is very often caused by a client trying to connect to a web application by using HTTP protocol when the web application requires HTTPS. The web server sends back a 302 response to the client in an attempt to redirect it to the secure HTTPS port.

[[Category: Unity Connection APIs]]

Cisco Unity Connection REST API FAQ

2010-12-15T22:15:54Z

Gscorbin:

Cisco Unity Connection APIs

2010-12-15T22:15:26Z

Gscorbin: /* Connection API Resources */

Cisco Unity Connection is a feature-rich voice messaging platform based on the same Linux operating system as Cisco Unified Communications Manager. Connection users can access voice messages by using email, web clients, mobile devices, instant messaging, and desktop clients such as Cisco Unified Personal Communicator; and can view, search, sort, and play messages on a Cisco Unified IP Phone display. Connection also provides comprehensive automated-attendant functions, including intelligent call routing and easily customizable call screen and message notification options. For more information see [http://www.cisco.com/en/US/products/ps6509/tsd_products_support_series_home.html Cisco Unity Connection documentation on Cisco.com].

Cisco Unity Connection includes several Representational State Transfer (REST) application programming interfaces (APIs) that provide provisioning, messaging, and telephony access to Connection. These APIs provide the ability to integrate Connection features into existing enterprise-wide provisioning management systems and messaging clients.
The APIs are REST interfaces that standardize operations such as add, delete, view, and modify.

== Available Connection REST APIs ==

'''CUPI''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API]]

The Cisco Unity Connection Provisioning Interface (CUPI) API provides access to the most commonly provisioned data on Cisco Unity Connection systems—users, contacts, distribution lists, and call handlers.

'''CUPI for End Users''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_For_End_Users]]

The Cisco Unity Connection Provisioning Interface (CUPI) API includes access for individual users when authenticating against user credentials. This allows for custom end-user applications.

'''CUMI''': [[Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]

The Cisco Unity Connection Messaging Interface (CUMI) API provides access to user messages.

'''CUTI''': [[Cisco_Unity_Connection_Telephony_Interface_(CUTI)_API]]

The Cisco Unity Connection Telephony Interface (CUTI) API provides the ability to play and record audio content over the phone.

'''CUNI''': [[Cisco_Unity_Connection_Notification_Interface_(CUNI)_API]]

The Cisco Unity Connection Notification Interface (CUNI) API provides notification for one or more users. CUNI is designed for use in server-to-server applications where receiving notifications for many users over a single connection is required.

== Other Connection API Resources ==

[[Cisco_Unity_Connection_REST_API_FAQ|FAQ]]

[[Cisco_Unity_Connection_APIs_--_Troubleshooting|Troubleshooting]]

[[Category: Unity Connection APIs]]

Cisco Unity Connection APIs

2010-12-15T22:15:08Z

Gscorbin: /* Connection REST API Resources */

Cisco Unity Connection is a feature-rich voice messaging platform based on the same Linux operating system as Cisco Unified Communications Manager. Connection users can access voice messages by using email, web clients, mobile devices, instant messaging, and desktop clients such as Cisco Unified Personal Communicator; and can view, search, sort, and play messages on a Cisco Unified IP Phone display. Connection also provides comprehensive automated-attendant functions, including intelligent call routing and easily customizable call screen and message notification options. For more information see [http://www.cisco.com/en/US/products/ps6509/tsd_products_support_series_home.html Cisco Unity Connection documentation on Cisco.com].

Cisco Unity Connection includes several Representational State Transfer (REST) application programming interfaces (APIs) that provide provisioning, messaging, and telephony access to Connection. These APIs provide the ability to integrate Connection features into existing enterprise-wide provisioning management systems and messaging clients.
The APIs are REST interfaces that standardize operations such as add, delete, view, and modify.

== Available Connection REST APIs ==

'''CUPI''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API]]

The Cisco Unity Connection Provisioning Interface (CUPI) API provides access to the most commonly provisioned data on Cisco Unity Connection systems—users, contacts, distribution lists, and call handlers.

'''CUPI for End Users''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_For_End_Users]]

The Cisco Unity Connection Provisioning Interface (CUPI) API includes access for individual users when authenticating against user credentials. This allows for custom end-user applications.

'''CUMI''': [[Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]

The Cisco Unity Connection Messaging Interface (CUMI) API provides access to user messages.

'''CUTI''': [[Cisco_Unity_Connection_Telephony_Interface_(CUTI)_API]]

The Cisco Unity Connection Telephony Interface (CUTI) API provides the ability to play and record audio content over the phone.

'''CUNI''': [[Cisco_Unity_Connection_Notification_Interface_(CUNI)_API]]

The Cisco Unity Connection Notification Interface (CUNI) API provides notification for one or more users. CUNI is designed for use in server-to-server applications where receiving notifications for many users over a single connection is required.

== Connection API Resources ==

[[Cisco_Unity_Connection_REST_API_FAQ|FAQ]]

[[Cisco_Unity_Connection_APIs_--_Troubleshooting|Troubleshooting]]

[[Category: Unity Connection APIs]]

Cisco Unity Connection APIs

2010-12-15T22:14:31Z

Gscorbin: /* Connection REST API Resources */

Cisco Unity Connection is a feature-rich voice messaging platform based on the same Linux operating system as Cisco Unified Communications Manager. Connection users can access voice messages by using email, web clients, mobile devices, instant messaging, and desktop clients such as Cisco Unified Personal Communicator; and can view, search, sort, and play messages on a Cisco Unified IP Phone display. Connection also provides comprehensive automated-attendant functions, including intelligent call routing and easily customizable call screen and message notification options. For more information see [http://www.cisco.com/en/US/products/ps6509/tsd_products_support_series_home.html Cisco Unity Connection documentation on Cisco.com].

Cisco Unity Connection includes several Representational State Transfer (REST) application programming interfaces (APIs) that provide provisioning, messaging, and telephony access to Connection. These APIs provide the ability to integrate Connection features into existing enterprise-wide provisioning management systems and messaging clients.
The APIs are REST interfaces that standardize operations such as add, delete, view, and modify.

== Available Connection REST APIs ==

'''CUPI''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API]]

The Cisco Unity Connection Provisioning Interface (CUPI) API provides access to the most commonly provisioned data on Cisco Unity Connection systems—users, contacts, distribution lists, and call handlers.

'''CUPI for End Users''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_For_End_Users]]

The Cisco Unity Connection Provisioning Interface (CUPI) API includes access for individual users when authenticating against user credentials. This allows for custom end-user applications.

'''CUMI''': [[Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]

The Cisco Unity Connection Messaging Interface (CUMI) API provides access to user messages.

'''CUTI''': [[Cisco_Unity_Connection_Telephony_Interface_(CUTI)_API]]

The Cisco Unity Connection Telephony Interface (CUTI) API provides the ability to play and record audio content over the phone.

'''CUNI''': [[Cisco_Unity_Connection_Notification_Interface_(CUNI)_API]]

The Cisco Unity Connection Notification Interface (CUNI) API provides notification for one or more users. CUNI is designed for use in server-to-server applications where receiving notifications for many users over a single connection is required.

== Connection REST API Resources ==

[[Cisco_Unity_Connection_REST_API_FAQ|FAQ]]

[[Cisco_Unity_Connection_APIs_--_Troubleshooting|Troubleshooting]]

[[Category: Unity Connection APIs]]

Cisco Unity Connection APIs

2010-12-15T22:14:15Z

Gscorbin: /* Connection REST API Resources */

Cisco Unity Connection is a feature-rich voice messaging platform based on the same Linux operating system as Cisco Unified Communications Manager. Connection users can access voice messages by using email, web clients, mobile devices, instant messaging, and desktop clients such as Cisco Unified Personal Communicator; and can view, search, sort, and play messages on a Cisco Unified IP Phone display. Connection also provides comprehensive automated-attendant functions, including intelligent call routing and easily customizable call screen and message notification options. For more information see [http://www.cisco.com/en/US/products/ps6509/tsd_products_support_series_home.html Cisco Unity Connection documentation on Cisco.com].

Cisco Unity Connection includes several Representational State Transfer (REST) application programming interfaces (APIs) that provide provisioning, messaging, and telephony access to Connection. These APIs provide the ability to integrate Connection features into existing enterprise-wide provisioning management systems and messaging clients.
The APIs are REST interfaces that standardize operations such as add, delete, view, and modify.

== Available Connection REST APIs ==

'''CUPI''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API]]

The Cisco Unity Connection Provisioning Interface (CUPI) API provides access to the most commonly provisioned data on Cisco Unity Connection systems—users, contacts, distribution lists, and call handlers.

'''CUPI for End Users''': [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_For_End_Users]]

The Cisco Unity Connection Provisioning Interface (CUPI) API includes access for individual users when authenticating against user credentials. This allows for custom end-user applications.

'''CUMI''': [[Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]

The Cisco Unity Connection Messaging Interface (CUMI) API provides access to user messages.

'''CUTI''': [[Cisco_Unity_Connection_Telephony_Interface_(CUTI)_API]]

The Cisco Unity Connection Telephony Interface (CUTI) API provides the ability to play and record audio content over the phone.

'''CUNI''': [[Cisco_Unity_Connection_Notification_Interface_(CUNI)_API]]

The Cisco Unity Connection Notification Interface (CUNI) API provides notification for one or more users. CUNI is designed for use in server-to-server applications where receiving notifications for many users over a single connection is required.

== Connection REST API Resources ==

[[Cisco_Unity_Connection_REST_API_FAQ|FAQ]]

[[Cisco_Unity_Connection_APIs_--_Troubleshooting\Troubleshooting]]

[[Category: Unity Connection APIs]]

Cisco Unity Connection Notification Interface (CUNI) API -- CUNI FAQs

2010-12-14T23:45:12Z

Gscorbin: /* Where Can I Get the WSDL? */

Cisco Unity Connection Notification Interface (CUNI) API -- CUNI FAQs

2010-12-14T23:44:46Z

Gscorbin: /* Where Can I Get the WSDL? */

Cisco Unity Connection Notification Interface (CUNI) API -- CUNI FAQs

2010-12-14T23:44:07Z

Gscorbin: /* Where Can I Get the WSDL? */

Cisco Unity Connection Notification Interface (CUNI) API -- Subscribing to and Processing Notification Events

2010-12-14T19:25:28Z

Gscorbin:

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUNI Guide Contents'''
|-
|[[Cisco Unity Connection Notification Interface (CUNI) API|API Overview ]] [[Cisco Unity Connection Notification Interface (CUNI) API -- CUNI Event Schema|CUNI Event Schema]] [[Cisco Unity Connection Notification Interface (CUNI) API -- Subscribing to and Processing Notification Events|Subscribing to and Processing Notification Events]] [[Cisco Unity Connection Notification Interface (CUNI) API -- CUNI FAQs|CUNI FAQs]]
|}

__TOC__

== Subscribing to Notification Events ==

Subscribing to notification events is done through the web service interface, and can be as simple as a single web service call to "subscribe".

At a minimum you should pass in:

* The callback URL where XML notifications will be posted by the Notifier
* The date/time when the subscription will expire

It is also possible to pass in a list of the resources (userid) that you are interested in receiving events for, although that can also be done via a subsequent call to "addResourceIdToSubscription". We recommend that you leave the eventTypeList empty, indicating that you would like to receive all types of message events.

This example shows making a call to subscribe in Java, using Axis2 stubs generated from the WSDL:

<pre>
Calendar expiration = java.util.Calendar.getInstance();
com.cisco.unity.messageeventservice.MessageEventServiceStub.Subscribe s =
new com.cisco.unity.messageeventservice.MessageEventServiceStub.Subscribe();

// Set subscription expiry to two months from now.
expiration.add(Calendar.MONTH, 2);
s.setExpiration(expiration);

// Specify the users we're interested in, which is just the operator for this example.
ArrayOfString resourceList = new ArrayOfString();
resourceList.addString("operator");

s.setResourceIdList(resourceList);
s.setExpiration(expiration);

// Set the callback information - a username and password can be specified, but they are optional.
MessageEventServiceStub.CallbackServiceInfo c = new MessageEventServiceStub.CallbackServiceInfo();
c.setCallbackServiceUrl(callbackUrl);
c.setPassword(callbackPassword);
c.setUsername(callbackUserId);
s.setCallbackServiceInfo(c);

// Subscribe!
SubscribeResponse r = stub.subscribe(s);
</pre>

== Processing Notification Events ==

Events will be delivered via HTTP POST to the callback URL that was provided in the call to subscribe.

There are four basic types of events:

{| border="1" cellspacing="0" cellpadding="5" align="center"
! Event Type
! Description
|-
| NEW_MESSAGE
| Sent when a new message arrives in a user Inbox.
|-
| SAVED_MESSAGE
| Sent when a message is marked as read.
|-
| UNREAD_MESSAGE
| Sent when a message is marked as unread.
|-
| DELETED_MESSAGE
| Sent when a message is deleted. (Note that this is sent on either a "hard" or "soft" delete. In the case of a soft delete, when the message is deleted from the deleted items list, no further event is sent out.)
|}

=== Example ===

This is an example of an event xml. Keep in mind that it is valid to have more than one messageInfo per messageEvent:

<pre>
<?xml version="1.0" ?>
<messageEvent subscriptionId="00bdcfd3-159a-48d3-ac7b-2f3b4f83db6c"
eventType="SAVED_MESSAGE"
eventTime="11:15:40 PM 10/30/2008"
mailboxId="abell"
displayName="Alexander Bell"
USN="2265">
<messageInfo messageId="72204bd7-e5c3-446e-adb6-ae5f80db26fb"
receiveTime="04:15:40 PM 10/30/2008"
uid="543"
msgType="Voice"
priority="Normal-Priority"
sender="null"
callerAni="null" />
</messageEvent>
</pre>

[[Category:Cisco Unity Connection Notification Interface (CUNI) API]]

Cisco Unity Connection Notification Interface (CUNI) API -- CUNI Event Schema

2010-12-14T19:25:12Z

Gscorbin:

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUNI Guide Contents'''
|-
|[[Cisco Unity Connection Notification Interface (CUNI) API|API Overview ]] [[Cisco Unity Connection Notification Interface (CUNI) API -- CUNI Event Schema|CUNI Event Schema]] [[Cisco Unity Connection Notification Interface (CUNI) API -- Subscribing to and Processing Notification Events|Subscribing to and Processing Notification Events]] [[Cisco Unity Connection Notification Interface (CUNI) API -- CUNI FAQs|CUNI FAQs]]
|}

__TOC__

== Schema Example ==

<pre>
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns="\[http://www.cisco.com"\] elementFormDefault="qualified" targetNamespace="\[http://www.cisco.com"\] xmlns:xs="\[http://www.w3.org/2001/XMLSchema">\]
<xs:simpleType name="priorityType">
<xs:restriction base="xs:string">
<xs:enumeration value="Low-Priority" />
<xs:enumeration value="Normal-Priority" />
<xs:enumeration value="Urgent" />
<xs:enumeration value="Unknown-Priority" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="eventType">
<xs:restriction base="xs:string">
<xs:enumeration value="MESSAGE_INFO" />
<xs:enumeration value="NEW_MESSAGE" />
<xs:enumeration value="SAVED_MESSAGE" />
<xs:enumeration value="UNREAD_MESSAGE" />
<xs:enumeration value="DELETED_MESSAGE" />
<xs:enumeration value="FAILOVER" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="messageType">
<xs:restriction base="xs:string">
<xs:enumeration value="Voice" />
<xs:enumeration value="NDR" />
<xs:enumeration value="DR" />
<xs:enumeration value="RR" />
<xs:enumeration value="Fax" />
<xs:enumeration value="Text" />
<xs:enumeration value="UnknownType" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="messageInfoType">
<xs:attribute name="messageId" type="xs:string" />
<xs:attribute name="receiveTime" type="xs:string" />
<xs:attribute name="msgType" type="messageType" />
<xs:attribute name="uid" type="xs:integer" />
<xs:attribute name="priority" type="priorityType" />
<xs:attribute name="sender" type="xs:string" />
<xs:attribute name="callerAni" type="xs:string" />
</xs:complexType>
<xs:element name="messageEvent">
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="unbounded">
<xs:element name="messageInfo" type="messageInfoType" />
</xs:sequence>
<xs:attribute name="subscriptionId" type="xs:string" />
<xs:attribute name="eventType" type="eventType" />
<xs:attribute name="eventTime" type="xs:string" />
<xs:attribute name="mailboxId" type="xs:string" />
<xs:attribute name="displayName" type="xs:string" />
<xs:attribute name="USN" type="xs:integer" />
</xs:complexType>
</xs:element>
</xs:schema>
</pre>

[[Category:Cisco Unity Connection Notification Interface (CUNI) API]]

Cisco Unity Connection Telephony Interface (CUTI) API -- Using CUTI for Basic Call Operations

2010-12-14T19:08:19Z

Gscorbin: /* Examples */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUTI Guide Contents'''
|-
|[[Cisco Unity Connection Telephony Interface (CUTI) API|API Overview ]] [[Cisco Unity Connection Telephony Interface (CUTI) API -- Using CUTI for Basic Call Operations|Using CUTI for Basic Call Operations]]
|}

__TOC__

== About Basic Call Operations ==

The basic call operations are making a call, checking call-connected status, and hanging up. The call object is used to convey information about a call (see API XSD's).

When making a call, the following fields are used:

* '''number''': the only field that does not have a default value. Users with the system administrator role can call any number, but end users can call only those numbers that do not violate their associated restriction table, based on their class of service.
* '''maximumRings''': defaults to 4.
* '''mediaSwitchObjectId''': for end users, defaults to the phone system that is associated with the user. For users who do not have an associated phone system (for example, administrators), the phone system that is marked as the default TRAP phone system is used.

When a call has been placed, a client can get server information about the call, most importantly the connected status.

The following are HTTP commands for basic call operations:

<pre>
POST http://<server>/calls:
Create a call (make a phone call) by using the information in a call object.
Returns a URI for the new call.

GET http://<server>/calls/<call id>: Get basic call information. Returns a call object.

DELETE http://<server>/calls/<call id>: Hangs up a call.
</pre>

== Playing and Recording by Using a Call ==

Files on the server can be played and recorded by phone (using the call control operations) by using the CallControl object (see API XSD's). The fields of the CallControl object are described below:

* '''opType''': PLAY, RECORD or STOP
* '''resourceType''': MESSAGE, BROADCASTMESSAGE or STREAM. STREAM is generally a temporary resource created by a record operation.
* '''resourceID''': Can be a message identifier, a broadcast message identifier or a stream identifier depending on the resource type.
* '''Speed''', '''volume''' and '''startPosition''' are all optional parameters. Speed and volume are a percentage and default to 100. The start position indicates a time in milliseconds and defaults to 0.
* '''lastResult''': The result of the last call control operation.
* '''folderType''': Reserved. Only messages in the inbox can be played.

A call control object is passed to a call by using a POST to the resource URI of the call:

<pre>
POST http://<server>/vmrest/calls/<call id>
</pre>

== Examples ==

The examples below show how to: make a call, check call status, record by phone, play the recording, hang up, and send the recording as a message. Each step is shown as the HTTP request and response.

=== Make the call ===

<pre>
POST /vmrest/calls HTTP/1.1
Content-Type: application/json

Accept: application/json

User-Agent: Java/1.6.0_17

Host: cuc-install-67.cisco.com

Connection: keep-alive

Authorization: Basic
Y2NtYWRtaW5pc3RyYXRvcjplY3NidWxhYg==
Content-Length: 36

{"number":"2119","maximumRings":"4"}
</pre>

Response:

<pre>
HTTP/1.1 201 Created
Set-Cookie:
JSESSIONIDSSO=CB2BE1D9771621DBEA24B479C1A9C10A; Path=/
Set-Cookie:
JSESSIONID=EB7C33B4DC0AAE91CB002D799C8734BA; Path=/vmrest
Location:
[http://cuc-install-67.cisco.com/vmrest/calls/vmrest/calls/1]
Content-Type: application/json
Transfer-Encoding: chunked

Date: Fri, 15 Jan 2010 15:14:11 GMT
Server:
</pre>

=== Check call status ===

<pre>
GET /vmrest/calls/1 HTTP/1.1
Accept: application/json

User-Agent: Java/1.6.0_17
Host: cuc-install-67.cisco.com

Connection: keep-alive
authorization: Basic Y2NtYWRtaW5pc3RyYXRvcjplY3NidWxhYg==
</pre>

Response:

<pre>
HTTP/1.1 200 OK
Pragma: No-cache
Cache-Control: no-cache
Expires: Wed, 31 Dec 1969 16:00:00 PST
Set-Cookie: JSESSIONIDSSO=849167D3D61D2F30BA278BBF949FDF0F; Path=/
Set-Cookie: JSESSIONID=28A69142E490EC63A56690F9811BDDF9; Path=/vmrest
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 15 Jan 2010 15:14:11 GMT
Server:

{"id":"1","connected":"true","nativeConnectionId":"2"}
</pre>

=== Record by phone ===

<pre>
POST /vmrest/calls/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
User-Agent: Java/1.6.0_17
Host: cuc-install-67.cisco.com
Connection: keep-alive
Authorization: Basic Y2NtYWRtaW5pc3RyYXRvcjplY3NidWxhYg==
Content-Length: 15
{"op":"RECORD"}
</pre>

Response:

<pre>
HTTP/1.1 200 OK
Set-Cookie: JSESSIONIDSSO=8279B639488165EFFAC8D330FD2A1281; Path=/
Set-Cookie: JSESSIONID=AA008CFCC9B329EA961CD1E660384785; Path=/vmrest
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 15 Jan 2010 15:14:13 GMT
Server:
{"op":"RECORD","resourceType":"STREAM","resourceId":"cf1cb014-6394- 4279-ab5a-74a6d680e440.wav",
"lastResult":"0","speed":"100","volume":"100","startPosition":"0"}
</pre>

=== Play the recording ===

<pre>
POST /vmrest/calls/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
User-Agent: Java/1.6.0_17
Host: cuc-install-67.cisco.com
Connection: keep-alive
Authorization: Basic Y2NtYWRtaW5pc3RyYXRvcjplY3NidWxhYg==
Content-Length: 159

{"op":"PLAY","resourceType":"STREAM","resourceId":"cf1cb014-6394-4279-ab5a-74a6d680e440.wav",
"lastResult":"0","speed":"100","volume":"100","startPosition":"0"}
</pre>

Response:

<pre>
HTTP/1.1 200 OK
Set-Cookie: JSESSIONIDSSO=CD7B1064CEB9385B6FE9279ECBDB40E3; Path=/
Set-Cookie: JSESSIONID=201BD26E840AA2CEEC242A9CCD0FE8F6; Path=/vmrest
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 15 Jan 2010 15:14:15 GMT
Server:

{"op":"PLAY","resourceType":"STREAM","resourceId":"cf1cb014-6394-4279-ab5a-74a6d680e440.wav",
"lastResult":"0","speed":"100","volume":"100","startPosition":"0"}
</pre>

=== Hang up ===

<pre>
DELETE /vmrest/calls/1 HTTP/1.1
Content-Type: application/json
User-Agent: Java/1.6.0_17
Host: cuc-install-67.cisco.com
Accept: text/html, image/gif, image/jpeg, \*; q=.2, \*/*; q=.2
Connection: keep-alive
Authorization: Basic Y2NtYWRtaW5pc3RyYXRvcjplY3NidWxhYg==
</pre>

Response:

<pre>
HTTP/1.1 204 No Content
Pragma: No-cache
Cache-Control: no-cache
Expires: Wed, 31 Dec 1969 16:00:00 PST
Set-Cookie: JSESSIONIDSSO=93B286C6584533F9EE793A01E5804465; Path=/
Set-Cookie: JSESSIONID=0CCFFFCAD1C11A45EAD1E8F04B22D28D; Path=/vmrest
Date: Fri, 15 Jan 2010 15:14:15 GMT
Server:
</pre>

=== Send the recording as a message ===

<pre>
POST /vmrest/messages?userobjectid=84c14db9-7439-4326-a2e2-e516aa192dff HTTP/1.1
Content-Type: multipart/form-data;boundary=Boundary_1_16617866_1263568442453
Accept: application/json
User-Agent: Java/1.6.0_17
Host: cuc-install-67.cisco.com
Connection: keep-alive
Authorization: Basic Y2NtYWRtaW5pc3RyYXRvcjplY3NidWxhYg==
Content-Length: 731

\--Boundary_1_16617866_1263568442453
Content-Type: application/json
{"Subject":"send message test","ArrivalTime":"0","FromSub":"false"}
\--Boundary_1_16617866_1263568442453
Content-Type: application/json

{"Recipient":{"Type":"TO","Address":
{"UserGuid":"84c14db9-7439-4326-a2e2-e516aa192dff","DisplayName":"Operator"}
}}
\--Boundary_1_16617866_1263568442453
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CallControl><op>PLAY</op><resourceType>STREAM</resourceType><resourceId>cf1cb014-6394-4279-
ab5a-74a6d680e440.wav</resourceId><lastResult>0</lastResult><speed>100</speed><volume>100</volume><startPosition>0</startPosition></CallControl>

\--Boundary_1_16617866_1263568442453-\-
</pre>

Response:

<pre>
HTTP/1.1 202 Accepted
Set-Cookie: JSESSIONIDSSO=3D875CAE50B6B4947DEDCF5EDA119922; Path=/
Set-Cookie: JSESSIONID=842B1A6E53DAE329F6DA7525951668B4; Path=/vmrest
Content-Type: application/json
Content-Length: 0
Date: Fri, 15 Jan 2010 15:14:16 GMT
Server:
</pre>

[[Category:Cisco Unity Connection Telephony Interface (CUTI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values

2010-12-14T01:24:10Z

Gscorbin:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values

2010-12-14T00:38:03Z

Gscorbin:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Configuration Values

2010-12-14T00:37:13Z

Gscorbin: 1 revision

Category:Cisco Unity Connection Telephony Interface (CUTI) API

2010-12-14T00:33:37Z

Gscorbin: New page: Category: Unity Connection APIs

[[Category: Unity Connection APIs]]

Category:Cisco Unity Connection Messaging Interface (CUMI) API

2010-12-14T00:33:23Z

Gscorbin: New page: Category: Unity Connection APIs

[[Category: Unity Connection APIs]]

Category:Unity Connection APIs

2010-12-14T00:32:16Z

Gscorbin: New page: Category: Cisco Products

[[Category: Cisco Products]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Transfer Options

2010-12-14T00:05:09Z

Cisco Unity Connection Provisioning Interface (CUPI) API -- Enabling Single Inbox Example

2010-12-14T00:05:07Z

Gscorbin: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Class of Service (COS)

2010-12-14T00:05:07Z

Gscorbin: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Primary and Alternate Extensions

2010-12-14T00:05:07Z

Gscorbin: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Changing Passwords and Password Settings

2010-12-14T00:05:07Z

Gscorbin: 1 revision