Querying System Status by Agent

Description

This interface is invoked to query system status 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/teamagentstatusinfo

Request URL

https://ip:port/rest/cmsapp/v1/openapi/querymonitor/systemstate

In the URL, 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	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.

Message header
Content-Type:application/json; charset=UTF-8
Message body
The following provides an example of the request message body of this interface:
```
{
    "queryParam":
    {
        "ccId":1, 
        "vdn":1
    }
}
```

Table 2 describes the parameters in the request message body of this interface.

**Table 2** Parameters in the message body
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.

Response Message

The following provides an example of the response message body of this interface:

{
  "result": "0",
  "resultDesc": {
    "busyagent": 0,
    "talkingnum": 0,
    "Idleagent": 0,
    "totalloginagent": 0
  }
}

Table 3 describes the parameters in the response message body of this interface.

**Table 3** Parameters in the message body
Parameter	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.
resultDatas	Object	Object in the returned result after a successful query. For details about the parameters of this object, see Table 4.

**Table 4** Parameters of resultDatas
Parameter	Type	Description
busyagent	Integer	Number of busy agents.
talkingnum	Integer	Number of agents in talking state.
Idleagent	Integer	Number of idle agents.
totalloginagent	Integer	Number of sign-in agents.