Querying System Status by Agent

Scenario

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 Interface

BMS interface: /ccbms/ws/monitor/teamagentstatusinfo

Request URL

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

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
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	Parameter for determining 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. page indicates the start page of the query.
4	limit	Integer	Yes	Number of query records on each page. The value ranges from 1 to 100.

Response Description

**Table 3** Parameters in the message body
No.	Parameter	Value Type	Description
1	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.
2	resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
3	resultDatas	Object	Object in the returned result after a successful query. For details about the parameters of this object, see Table 4. NOTE: This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.
4	resultDesc	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 resultDesc/resultDatas
No.	Parameter	Value Type	Description
2.1	busyAgent	Integer	Number of busy agents.
2.2	talkingNum	Integer	Number of agents in talking state.
2.3	idleAgent	Integer	Number of idle agents.
2.4	totalLoginAgent	Integer	Number of signed-in agents.
NOTE: The response result is the agent status data obtained based on the pagination parameters limit and offset in the request. For example, if both limit and offset are set to 10, the 10 agents on the second page (10 agents per page) are obtained, and then status statistics on the 10 agents are collected.

Message Example

Message body

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

{
    "queryParam":
    {
        "ccId":1, 
        "vdn":1,
        "offset":0,
        "limit":100
    }
}

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

{
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": {
        "busyAgent": 0,
        "talkingNum": 0,
        "idleAgent": 0,
        "totalLoginAgent": 0
    },
    "resultDesc": {
        "busyAgent": 0,
        "talkingNum": 0,
        "idleAgent": 0,
        "totalLoginAgent": 0
    }
}

Parent topic: Real-Time Interfaces for Agents

Previous topic: Checking Whether an Agent Is Processing a Call

Next topic: Obtaining Real-Time Monitoring Indicators by Agent