Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Basics, Voice Name, Greetings
From DocWiki
m (1 revision) |
|||
| Line 4: | Line 4: | ||
|- | |- | ||
|[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|API Overview ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Basics, Voice Name, Greetings |Basics, Voice Name, Greetings ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Unified Messaging Accounts |Unified Messaging Accounts ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Alternate Devices |Alternate Devices ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Directory |Directory ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Enabling and Disabling Greetings |Enabling and Disabling Greetings ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Location |Location ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Private Lists |Private Lists ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- SMTP Proxy Addresses |SMTP Proxy Addresses ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- System Configuration |System Configuration ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Transfer Options |Transfer Options ]] | |[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users|API Overview ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Basics, Voice Name, Greetings |Basics, Voice Name, Greetings ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Unified Messaging Accounts |Unified Messaging Accounts ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Alternate Devices |Alternate Devices ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Directory |Directory ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Enabling and Disabling Greetings |Enabling and Disabling Greetings ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Location |Location ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Private Lists |Private Lists ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- SMTP Proxy Addresses |SMTP Proxy Addresses ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- System Configuration |System Configuration ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- Transfer Options |Transfer Options ]] | ||
| + | |} | ||
| + | |||
| + | {| border="1" class="wikitable" | ||
| + | |- | ||
| + | ! style="background-color: rgb(255, 215, 0);" | '''Back to:''' [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_For_End_Users|CUPI for End Users Overview ]] | ||
|} | |} | ||
Revision as of 17:14, 15 April 2012
Links to Other API pages: Cisco_Unity_Connection_APIs
| CUPI for End Users Guide Contents |
| API Overview Basics, Voice Name, Greetings Unified Messaging Accounts Alternate Devices Directory Enabling and Disabling Greetings Location Private Lists SMTP Proxy Addresses System Configuration Transfer Options |
| Back to: CUPI for End Users Overview |
|---|
Contents |
Basic User Information
Do the following GET to see a subset of the User fields that an administrator can access:
GET /vmrest/user
Voice Name
The following GET allows end users to get the audio that is their recorded voice name and to change the audio:
GET /vmrest/user/voicename PUT /vmrest/user/voicename
PUT takes audio/wav data as the HTTP content.
Greeting Audio
The following GET allows end users to listen to and modify their personal greeting:
GET /vmrest/user/greetings/\{greeting type\}/greetingstreamfiles
The \{greeting type\} can be any one of the following:
- Standard
- Alternate
- Busy
- Closed
- Holiday
- Error
- Internal
An end user can have greetings in more than one language. The first resource allows users to access the list of greetings that currently have audio. It is possible that the user has no greetings recorded, in which case the list will be empty.
A GET will return a GreetingStreamFiles object that contains a set of GreetingStreamFile objects for the specified greeting type. Each GreetingStreamFile object will have a URI that allows access to the greeting audio. The individual audio URI's are in the format:
GET /vmrest/user/greetings/\{greeting type\}/greetingstreamfiles/\{language\}
The \{language\} is a locale identifier (e.g. 1033 is English - United States).
This resource identifier returns the audio of the greeting as an "audio/wav" media type:
PUT /vmrest/user/greetings/\{greeting type\}/greetingstreamfiles/\{language\}
The HTTP content type of the PUT is "audio/wav" and the payload content is the audio data. If the greeting for the given type and language does not exist, the greeting audio will be created. If the greeting audio already exists, the existing audio is replaced by the new audio.
Class of Service
The user's class of service (COS) can be retrieved but not set via the following URL:
GET /vmrest/user/cos
