Gscorbin: 1 revision

2010-12-14T00:05:07Z

1 revision

← Older revision

Revision as of 00:05, 14 December 2010

Juliew at 22:28, 13 December 2010

2010-12-13T22:28:54Z

New page

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== About Voice Names ==

Many objects available via the CUPI interface have a voice name field. There are two ways to access the voice name for these objects:

* For Connection versions 7.x and 8.0.x the voice names are accessed by using the VoiceFileURI. Modifying the voice name as a voice file requires a three step process as detailed below.

* For Connection versions 8.5 and later the voice name access has been simplified so that it can be accessed by using a VoiceNameURI. This new URI is a standard sub-resource of the primary resource URI (see example below). Modifying the voice name by using the new URI reduces the three step process to a single step. The old VoiceFileURI still works in the later versions of Connection, but use of the new URI is easier.

<pre>
http://<server>/users/<user object id>/voicename)
</pre>

== Listing and Viewing ==

=== Voice Name GET for Connection 8.5 and Later ===

Use the standard VoiceNameURI directly to get the file:

<pre>
GET http://<connection-server>/vmrest/<resource>/<resource id>/voicename
</pre>

The response will return the audio/wav data for the voice name.

=== Voice Name GET for Connection 7.x and 8.0.x ===

First get the primary resource to find out the voice file URI, then use the VoiceFileURI to get the file:

<pre>
GET http://<connection-server>/vmrest/voicefiles/<voice file name>
</pre>

The response will return the audio/wav data for the voice name.

== Setting Voice Names ==

=== Setting a Voice Name in Connection 8.5 and Later ===

PUT the audio data directly to the standard resource voice name URI:

<pre>
PUT /vmrest/<object>/<object id>/voicename

content is audio/wav data
</pre>

The response is a 204 indicating that the content has been accepted and copied into the temporary file.

=== Setting a Voice Name in Connection 7.x and 8.0.x ===

To create a voice name for a resource is a three step process.

Step 1: A place-holder for the WAV file must be created with a POST. This is a temporary file place-holder that can be used for up to 30 minutes. If it is not used within 30 minutes (assigned to a resource), the file is assumed to be abandoned and is automatically cleaned.

<pre>
POST /vmrest/voicefiles
</pre>

The response code is 201 and the content is the name of the newly created temporary file.

Step 2: Use the temporary file name to PUT the new audio data. The HTTP content type is "audio/wav" and the payload content is the audio data.

<pre>
PUT /vmrest/voicefiles/<temporary file name>
</pre>

The response is a 204 indicating that the content has been accepted and copied into the temporary file.

Step 3: Set the voicename field of the target resource to the temporary file name. See the example for a user below:

<pre>
PUT /vmrest/users/<user object id>

<?xml version="1.0" encoding="UTF-8"?>
<User>
<VoiceName>temporary file name</VoiceName>
</User>
</pre>

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Names - Revision history

Gscorbin: 1 revision

Juliew at 22:28, 13 December 2010