Cisco Unity Connection Provisioning Interface (CUPI) API -- Location API

From DocWiki

Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All End Users CUPI Documentation

Contents



Location API

This section contains information on how to use the API to list the details of your location when using CUPI APIs for users. The location object holds several critical pieces of information, but only select pieces of information are exposed to the end user through this URI.


Listing the Location Details of a User

GET http://<connection-server>/vmrest/user/location 

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

<ConnectionLocation>
  <DefaultWaveFormatObjectId>cb85b520-e2de-4878-96e2-3331607f4671</DefaultWaveFormatObjectId>
  <DefaultWaveFormatURI>/vmrest/waveformats/cb85b520-e2de-4878-96e2-3331607f4671</DefaultWaveFormatURI>
  <DisplayName>cuc-install-43</DisplayName>
</ConnectionLocation>
Response Code: 200

JSON Example

GET http://<connection-server>/vmrest/user/location
Accept: application/json 
Content-type: application/json
Connection: keep-alive 

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

{ 
  "DefaultWaveFormatObjectId": "cb85b520-e2de-4878-96e2-3331607f4671",
  "DefaultWaveFormatURI": "/vmrest/waveformats/cb85b520-e2de-4878-96e2-3331607f4671",
  "DisplayName": "cuc-install-43"
}
Response Code: 200

The default wave format is the wave format that your recorded messages are stored in.


Explanation of Data Fields:

Parameter Operations Data Type Comments
DefaultWaveFormatObjectId Read Only String(36) The unique identifier of the WaveFormat object that specifies the wave format in which recorded messages are stored if the requested format is not available on the system.
DefaultWaveFormatObjectIdURI Read Only String URI of the WaveFormat object that specifies the wave format in which recorded messages are stored if the requested format is not available on the system.
DisplayName Read Only String(64) Hostname of the Connection server.

Rating: 0.0/5 (0 votes cast)

Personal tools