Cisco Unity Connection Provisioning Interface (CUPI) API -- License User Entitlement

From DocWiki

Revision as of 08:37, 16 September 2013 by Subabhat (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


License User Entitlement APIs

Administrator can use this API to fetch users belonging to a tenant and their license information which includes messaging and Speech view.


Listing the Users with Their Licensing Details Who Belongs to a Particular Tenant

Obtain the Object ID of the tenant that you want to list the user licenses for:

GET https://<connection-server>/vmrest/tenants

Perform a GET operation on the tenant Objec tID using the following URI to list all the user licenses:

GET https://<connection-server>/vmrest/tenants/c9d9c29d-4a81-47b5-9296-34b193cff5bb/userlicenses

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

<UserLicenses total="1">
  <UserLicense>
     <Alias>raman@Texoma.com</Alias>
     <DtmfAccessId>1234</DtmfAccessId>
     <Messaging>Basic</Messaging>
     <SpeechView>Speech View Standard</SpeechView>
  </UserLicense></UserLicenses
Response Code: 200

JSON Example

To list all the user licenses, use the following:

Request URI:
GET https://<connection-server>/vmrest/tenants/c9d9c29d-4a81-47b5-9296-34b193cff5bb/userlicenses
Accept: application /json
Connection: keep-alive

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

{
  "@total": "1",
  "UserLicense":
  [
  {
     "Alias": "raman",
     "DtmfAccessId": "1234",
     "PartitionObjectId": "6a4ac446-8b88-4456-aad7-099f249958fa",
     "Messaging": "Basic",
     "SpeechView": "Speech View Standard"
  }
  ]
}
Response Code: 200


List Users by Performing an Query

Users can be queried based on all the fields of the License User Entitlement API, namely, Alias, DtmfAccessId, Messaging, SpeechView.

Obtain the Object ID of the tenant that you want to list the user licenses for:

GET https://<connection-server>/vmrest/tenants

Perform a GET operation on the tenant Object ID using the following URI to list the user licenses:

GET https://<connection-server>/vmrest/tenants/c9d9c29d-4a81-47b5-9296-
34b193cff5bb/userlicenses?query=(DtmfAccessId%20is%201234)

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

<UserLicenses total="1">
  <UserLicense>
     <Alias>raman@Texoma.com</Alias>
     <DtmfAccessId>1234</DtmfAccessId>
     <Messaging>Basic</Messaging>
     <SpeechView>Speech View Standard</SpeechView>
  </UserLicense>
</UserLicenses>
Response Code: 200

JSON Example

To list the user licenses, do the following:

Request URI:
GET https://<connection-server>/vmrest/tenants/c9d9c29d-4a81-47b5-9296-
34b193cff5bb/userlicenses?query=(DtmfAccessId%20is%201234)
Accept: application /json
Connection: keep-alive

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

{
     "@total": "1",
     "UserLicense": [{
     "Alias": "raman",
     "DtmfAccessId": "1234",
     "PartitionObjectId": "6a4ac446-8b88-4456-aad7-099f249958fa",
     "Messaging": "Basic",
     "SpeechView": "Speech View Standard"
     } ]
}
Response Code: 200


Explanation of Data Fields

Parameter Operations Data Type Comments
Alias Read Only String(64) The Alias of the user belonging to a Tenant.
dtmfAccessId Read Only String(40) The DTMF access id (i.e., extension) of the subscriber.
Messaging Read Only String Licensing Tag either Basic, Enhanced, Enhanced+
SpeechView Read Only String It is a licensing Tag that specifies the transcription service. Speech View Standard or Speech View Pro. This field is not displayed when users do not use the transcription service.

Rating: 0.0/5 (0 votes cast)

Personal tools