Cisco Unity Connection Provisioning Interface (CUPI) API -- License User Entitlement
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:
|
Perform a GET operation on the tenant Objec tID using the following URI to list all the user licenses:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To list all the user licenses, use the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
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:
|
Perform a GET operation on the tenant Object ID using the following URI to list the user licenses:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To list the user licenses, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Explanation of Data Fields
Parameters | 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. |