Querying Information About Static Configurations of All Agents in a Specified VDN
Scenario
This interface is invoked to query information about static configurations of all agents in a specified VDN.
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/vdn/queryagentstaticconfinfo
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 |
Value 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. |
No. |
Parameter |
Value Type |
Mandatory |
Description |
---|---|---|---|---|
1 |
ccId |
Integer |
Yes |
ID of a call center. The value ranges from 1 to 65535. |
2 |
vdn |
Integer |
Yes |
ID of a VDN. The value ranges from 1 to 5000. |
3 |
offset |
Integer |
Yes |
Pagination offset. The value is greater than or equal to 0. |
4 |
limit |
Integer |
Yes |
Pagination limit. The value ranges from 1 to 100. |
Response Description
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
1 |
result |
String |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference.
NOTE:
This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions. |
2 |
resultCode |
String |
Query result. The options are as follows:
|
3 |
resultDatas |
Array |
Object array in the returned result after a successful query. For details about the parameters of the object in this array, see Table 4.
NOTE:
This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions. |
4 |
resultDesc |
Array |
Object array in the returned result after a successful query. For details about the parameters of the object in this array, see Table 4. |
5 |
count |
Integer |
Total number of agents in the VDN. |
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
2.1 |
agentId |
Integer |
Agent ID. |
2.2 |
groupId |
Integer |
ID of the group to which an agent belongs. Currently, the value of this field is -1. Group: To facilitate the management of agents, the agents of a VDN are usually grouped. Agents in a group form an agent group. Currently, the AICC does not support the return value -1 of this field, which indicates that the agents do not belong to any agent group. |
2.3 |
rights |
String |
Permission value of an agent. The value 0 indicates that the agent has no permission, and 1 indicates that the agent has permission. Table 5 describes the role permission. |
2.4 |
name |
String |
Agent name. |
2.5 |
realFlag |
Integer |
Whether an agent is a network agent. The value 0 indicates network agent, and 1 indicates common agent. Currently, all agents in the AICC are common agents. |
Bit |
Description |
---|---|
1 |
Showing busy/idle. |
2 |
Muting/Unmuting calls. |
3 |
Holding calls/Canceling to hold calls. |
4 |
Connecting held calls. |
5 |
Making common outbound calls. |
6 |
Making internal calls. |
7 |
Transferring calls internally. |
8 |
Answering transferred inbound calls. |
9 |
Making three-party calls. |
10 |
Transferring out calls. |
11 |
Transferring calls from the agent service to automatic service. |
12 |
Rejecting inbound calls. |
13 |
Listening/Listening and inserting/Whispering. |
14 |
Intercepting calls. |
15 |
Forcibly signing out/Forcibly showing busy/Forcibly showing idle. |
16 |
Inspecting recordings/Inspecting voice playing. |
17 |
Monitoring inspections. |
18 |
Appraisal administrator. |
19 |
Ordinary appraisal personnel. |
20 |
Alarm console. |
21 |
Report handler. |
22 |
Reserved value. |
23 |
Monitoring console. |
24 |
Configuration administrator. |
25 |
Report administrator. |
26 |
Making national outbound toll calls. |
27 |
Making international outbound toll calls. |
28 |
Making outbound calls using access codes of the call center. |
29 |
Performing inspections in fullscreen mode. |
30 |
Picking up calls for the agents in the same agent group. |
31 |
Reserved value. |
32 |
Configuring agents. |
33 |
Configuring skills. |
34 |
Not setting the outbound call. |
35 |
Configuring the audit. |
36–128 |
Reserved value. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId":1, "vdn":170, "offset":0, "limit":100 }
- Response parameters
{ "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 1086, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601086", "realFlag": 1 }, { "agentId": 1087, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601087", "realFlag": 1 } ], "resultDesc": [ { "agentId": 1086, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601086", "realFlag": 1 }, { "agentId": 1087, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601087", "realFlag": 1 } ] }
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