Querying the Agent Information in Rest State

Description

This interface is invoked to query agent information in rest state.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

Internal Encapsulation Interfaces

BMS interfaces:

/ccbms/ws/monitor/teamrestinfo
/ccbms/ws/monitor/teamrestagentinfo

Request URL

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

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",
  "resultDatas": 
  {
    "allowrestnum": 101,
    "onrestnum": 1,
    "waitrestnum": 0,
    "agentsrestdetails": 
    {[
      "agentname": "z1",
      "workno":55001
      "cantrestreason":1
      "begintime":2345
      "restduration":22333
    ]}
  }
}

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
allowrestnum	Integer	Number of agents who are allowed to have a rest but still at work.
onrestnum	Integer	Number of agents that are resting.
waitrestnum	Integer	Number of agents who apply for rest.
agentsrestdetails	Array	List of details about agents who take a rest in the VDN. For details about the parameters of this object, see Table 5.

**Table 5** Parameters of agentsrestdetails
Parameter	Type	Description
agentname	String	Agent name.
workno	Integer	Agent ID.
cantrestreason	Integer	Reason why agents are not allowed to have a rest. This parameter is valid only for the agents who wait for a rest. For details about the parameters of this object, see Table 6.
begintime	Long	Start time. For resting agents, this parameter indicates the rest start time. For agents who are not in rest, this parameter indicates the requested or approved rest start time. The value is in the timestamp format.
restduration	Long	Requested rest duration, in seconds.

**Table 6** Reason for not allowing rest
Value of the Reason for Not Allowing Rest	Description
0	The agent is waiting for approval.
1	The agent is in busy state.
2	The number of agents who can take a rest in the VDN reaches the maximum.
3	The agent does not answer any inbound calls, because the agent does not sign in to any skill queues.
4	The number of resting agents in a skill queue the agent signs in reaches the maximum.