Obtaining Real-Time Monitoring Indicators by Agent
Description
This interface is used to obtain real-time monitoring indicators by agent.
Interface Method
The request method must be set to POST. This interface supports only the POST method.
Internal Encapsulation Interfaces
BMS interface: /ccbms/ws/monitor/agentstatusinfobyagentids
Request URL
https://ip:port/rest/cmsapp/v1/openapi/agentgroup/rindex
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 to 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 |
---|---|---|---|
ccId |
Integer |
Yes |
ID of a call center. The value ranges from 1 to 65535. |
vdn |
Integer |
Yes |
ID of a VDN. The value ranges from 1 to 5000. |
agentIds |
Array |
Yes |
Array of agent IDs. The maximum array length is 100. The value ranges from 101 to 59999. |
indexIds |
Array |
Yes |
Array of indicators. The maximum length of the array depends on the number of real-time monitoring indicators by agent. The maximum value is 4. For details about the parameters of this object, see Table 2. |
Response Message
Parameter |
Type |
Description |
---|---|---|
resultCode |
String |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference. |
resultDesc |
Array |
Object array in the returned result after a successful query. For details about the parameters of this object in the array, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Agent ID. |
idxs |
Array |
Group of indicators. For details about the parameters of this object, see Table 5. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Indicator ID. |
val |
Object |
Indicator result. For details about the parameters of this object, see Table 2. |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId":1, "vdn":170, "agentIds":[1032,1099], "indexIds":["IDX_AGENT_PHONE","IDX_AGENT_CURRENT_STATE","IDX_DURATION_AGENT_CURRENT_STATE","IDX_AGENT_LOGIN_SKILLS"] }
- Response parameters
{ "resultCode": "0100000", "resultDesc": [ { "idxs": [ { "val": "88880103", "id": "IDX_AGENT_PHONE" }, { "val": 7, "id": "IDX_AGENT_CURRENT_STATE" }, { "val": 17728, "id": "IDX_DURATION_AGENT_CURRENT_STATE" }, { "val": [ 3 ], "id": "IDX_AGENT_LOGIN_SKILLS" } ], "id": 1032 }, { "idxs": [ { "val": "88881609", "id": "IDX_AGENT_PHONE" }, { "val": 1, "id": "IDX_AGENT_CURRENT_STATE" }, { "val": 1414, "id": "IDX_DURATION_AGENT_CURRENT_STATE" }, { "val": [ 2, 4 ], "id": "IDX_AGENT_LOGIN_SKILLS" } ], "id": 1099 } ] }
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