Querying Information About All Agents by Tenant Space ID
Scenario
This interface is invoked to query information about all agents of a tenant based on the tenant space ID.
Interface Method
The request method must be set to POST. This interface supports only the POST method.
Request URL
https://ip:port/rest/cmsapp/v1/openapi/tenant/querytenantdetail
In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.
In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.
Request Description
No. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|---|
1 |
Content-Type |
String |
Yes |
The value is fixed at application/json; charset=UTF-8. |
2 |
Authorization |
String |
Yes |
For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
tenantId |
String |
Yes |
Tenant space ID. |
ccId |
Integer |
No |
ID of a call center.
|
limit |
Integer |
No |
Number of query records on each page. The value ranges from 1 to 10000. The default value is 10000.
NOTE:
|
offset |
Integer |
No |
offset is used to determine the start page of the query. Value of offset = Value of limit x (Value of page – 1). The value of offset is greater than or equal to 0. The default value is 0. page indicates the start page to be queried.
NOTE:
|
Response Description
Parameter |
Type |
Description |
---|---|---|
resultCode |
String |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference. |
resultDesc |
Object |
Object in the returned result after a successful query. For details about the parameters of this object, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
ccId |
Integer |
ID of a call center. |
tenantId |
String |
Tenant space ID. |
tenantSpaceName |
String |
Tenant space name. |
vdnId |
Integer |
ID of a VDN. |
accessCodes |
Array |
Access number list. For details about the parameters of the object in this array, see Table 4 Parameters of accessCodes. |
agents |
Array |
Agent list. For details about the parameters of agents, see Table 5 Parameters of agent. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId": 1, "tenantId": "202306131208", "limit": 10000, "offset": 0 }
- Response parameters
{ "resultCode": "0100000", "resultDesc": { "ccId": 3, "vdnId": 47, "tenantId": "202008142460", "accessCodes": [ { "accessCode": "202008191", "isDefault": true } ], "tenantSpaceName": "fjw081401", "agents": [{ "workNo": 111, "sipAccount": "88880001", "accountCode": "123", "agentType": 4 }] } }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot