Obtaining Real-Time Monitoring Indicators by Agent

Scenario

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 Interface

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

**Table 1** Parameters in the request header
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.

**Table 2** Parameters in the message body
Parameter	Value Type	Mandatory	Description
ccId	Integer	Yes	ID of a call center. The value ranges from 1 to 65535.
vdn	Integer	Yes	ID of a VCC. The value ranges from 1 to 5000.
agentIds	Array	Yes	Array of agent IDs. The maximum length of the array is 100. Value range: 101–59999 and 70000–999999
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 the object, see Table 2.

Response Description

**Table 3** Parameters in the message body
Parameter	Value Type	Description
result	String	Query result. The options are as follows: 0: success Other values: failure 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.
resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
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.
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.

**Table 4** Parameters of resultDesc/resultDatas
Parameter	Value Type	Description
id	Integer	Agent ID.
idxs	Array	Group of indicators. For details about the parameters of the object, see Table 5.

**Table 5** Parameter description of idxs
Parameter	Value Type	Description
id	String	Indicator ID.
val	Object	Indicator result. For details about the parameters of the 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

{
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "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
        }
    ],
    "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
        }
    ]
}

Parent topic: Real-Time Interfaces for Agents

Previous topic: Querying System Status by Agent

Next topic: Obtaining Agent Operation Details