Cisco Unity Connection Provisioning Interface (CUPI) API -- Custom Recordings

From DocWiki

Revision as of 09:58, 1 November 2013 by Deeptija (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


About Custom Recordings

Cisco Unity Connection allows you to play the customized recordings after a message is sent. You can also play the custom recordings after a greeting is played. A greeting is played before the callers are allowed to leave a message for a user or a call handler.

Note: In Cisco Unity Connection 9.0, the Post Greeting Recordings option is changed to the Custom Recordings option.

Listing Custom Recording

Example 1

The following is an example of the GET request that lists all the custom recordings:

https://<connection_server>/vmrest/postgreetingrecordings


The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<PostGreetingRecordings total="2">
<PostGreetingRecording>
  <URI>/vmrest/postgreetingrecordings/b7cfa709-9f06-4cd2-94b3-8e5910d5b041</URI> 
  <ObjectId>b7cfa709-9f06-4cd2-94b3-8e5910d5b041</ObjectId> 
  <DisplayName>Rec-2</DisplayName> 
  <PostGreetingRecordingStreamFilesURI>/vmrest/postgreetingrecordings/b7cfa709-
9f06-4cd2-94b3-8e5910d5b041/postgreetingrecordingstreamfiles</PostGreetingRecordingStreamFilesURI> 
  </PostGreetingRecording>
<PostGreetingRecording>
  <URI>/vmrest/postgreetingrecordings/db44de42-7274-4d1c-8837-e710b0649c13</URI> 
  <ObjectId>db44de42-7274-4d1c-8837-e710b0649c13</ObjectId> 
  <DisplayName>Rec-3</DisplayName> 
  <PostGreetingRecordingStreamFilesURI>/vmrest/postgreetingrecordings/db44de42-7274-
4d1c-8837-e710b0649c13/postgreetingrecordingstreamfiles</PostGreetingRecordingStreamFilesURI> 
</PostGreetingRecording>
</PostGreetingRecordings>
RESPONSE Code: 200 

Example 2

The following is an example of the GET request that lists the custom recording as represented by <objectId>:

https://<connection_server>/vmrest/postgreetingrecordings/<objectId>


The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<PostGreetingRecording>
  <URI>/vmrest/postgreetingrecordings/b7cfa709-9f06-4cd2-94b3-8e5910d5b041</URI> 
  <ObjectId>b7cfa709-9f06-4cd2-94b3-8e5910d5b041</ObjectId> 
  <DisplayName>Rec-2</DisplayName> 
  <PostGreetingRecordingStreamFilesURI>/vmrest/postgreetingrecordings/b7cfa709-9f06-4cd2-94b3-8e5910d5b041/postgreetingrecordingstreamfiles</PostGreetingRecordingStreamFilesURI> 
</PostGreetingRecording>
 RESPONSE Code: 200 

Listing Languages for a Custom Recording

Example 1

The following is an example of the GET request that lists all the languages/stream files for a custom recording:

 https://<connection_server>/vmrest/postgreetingrecordings/<objectId>/postgreetingrecordingstreamfiles 

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<PostGreetingRecordingStreamFiles>
<PostGreetingRecordingStreamFile>
  <URI>/vmrest/postgreetingrecordings/b7cfa709-9f06-4cd2-94b3-8e5910d5b041/postgreetingrecordingstreamfiles/1033/audio</URI> 
  <PostGreetingRecordingObjectId>b7cfa709-9f06-4cd2-94b3-8e5910d5b041</PostGreetingRecordingObjectId> 
  <LanguageCode>1033</LanguageCode> 
  <StreamFile>58b0c574-62e6-4276-8e25-cb1227570492.wav</StreamFile> 
  <PostGreetingStreamFileLanguageURI>/vmrest/postgreetingrecordings/b7cfa709-9f06-4cd2-94b3-8e5910d5b041/postgreetingrecordingstreamfiles/1033</PostGreetingStreamFileLanguageURI> 
</PostGreetingRecordingStreamFile>
</PostGreetingRecordingStreamFiles>
 RESPONSE Code: 200 

Example 2

The following is an example of the GET request that lists a particular languages/stream files for a custom recording represented by <language-code>:

 https://<connection_server>/vmrest/postgreetingrecordings/<objectId>/postgreetingrecordingstreamfiles/<language-code> 

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<PostGreetingRecordingStreamFile>
  <PostGreetingRecordingObjectId>b7cfa709-9f06-4cd2-94b3-8e5910d5b041</PostGreetingRecordingObjectId> 
  <LanguageCode>1033</LanguageCode> 
  <StreamFile>58b0c574-62e6-4276-8e25-cb1227570492.wav</StreamFile> 
</PostGreetingRecordingStreamFile>
 RESPONSE Code: 200 

Modifying Custom Recording

Example 1

The following is an example of the PUT request that modifies the custom recording as represented by <objectId>:

 https://<connection_server>/vmrest/postgreetingrecordings/<objectId>  

The following is an example of the response from the above *PUT* request and the actual response will depend upon the information given by you:

<PostGreetingRecording>
     <DisplayName>custom-rec</DisplayName>
</PostGreetingRecording>
 RESPONSE Code: 204 

Example 2

The following is an example of the PUT request that modifies a stream file for a custom recording as represented by <language-code>:

 https://<connection_server>/vmrest/postgreetingrecordings/<object-id>/postgreetingrecordingstreamfiles/<language-code>   

The following is an example of the response from the above *PUT* request and the actual response will depend upon the information given by you:

<PostGreetingRecordingStreamFile>
   <StreamFile>82dd9884-5cee-42f0-8537-bdc5e622de1f.wav</StreamFile>
</PostGreetingRecordingStreamFile>
 RESPONSE Code: 204 

Deleting Custom Recording

The following is an example of the DELETE request that deletes a User Template as represented by <usertemplateid>:


 https://<connection_server>/vmrest/postgreetingrecordings/<objectId> 


The output for this request returns the successful response code.

 RESPONSE Code: 204 

Explanation of Data Fields

The following chart lists all of the data fields available on custom.

Field Name Writable? DB Value Explanation / Comments
ObjectId Read-only 36 Characters ObjectId of the Device
DisplayName Read/Write 1-64 Characters Friendly name for the Device like "Mobile Phone"
PostGreetingRecordingStreamFilesURI Read-only List all the languages of custom recordings.
PostGreetingRecordingObjectId Read-only 36 Characters List all the custom recordings
LanguageCode Read-only 4 characters List all the locales/languages
StreamFile Read/Write 40 Characters Record Greetings

Rating: 0.0/5 (0 votes cast)

Personal tools