Querying Details About Agents in Configured Skill Queues

Description

This interface is invoked to query details about agents in configured skill queues.

Request Method

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

Internal Encapsulation Interfaces

BMS interface: /ccbms/ws/monitor/agentstatusinfo

Request URL

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

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,
        "skillId":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.
skillId	Integer	Yes	Skill queue ID. The value ranges from 1 to 2000.

Response Message

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

{
  "result": "0",
  "resultDatas": [{
    "workno": 20011,
    "name": "20011",
    "status": 4,
    "ctiStatus": 1,
    "groupid": 1,
    "mediatype": 1,
    "vdnid": 1,
    "phonenumber": "70942",
    "currentstatetime": 1505,
    "logindate": 1501125758000
  }]
}

Table 3 describes the parameters in the 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	Array	Array in the returned result after a successful query. For details about the parameters of this object in the array, see Table 4.

**Table 4** Parameters of resultDatas
Parameter	Type	Description
workno	Integer	Agent ID.
name	String	Agent name.
status	Integer	Agent status. For details, see Table 5.
ctiStatus	Integer	Agent platform status. For details, see CTI Platform Agent Status Code Reference.
groupid	Integer	Agent group ID.
mediatype	Integer	Agent media type. For details, see Table 1.
vdnid	Integer	ID of the VDN to which a call belongs.
phonenumber	String	Agent phone number.
currentstatetime	Long	Duration in the current state.
logindate	Long	Sign-in time.

**Table 5** Agent status
Value	Description
0	Unknown. The value corresponds to status 9 on the CTI platform.
2	An exception occurs when the interface is invoked.
3	Showing busy. The value corresponds to status 7 on the CTI platform.
4	Idle. The value corresponds to status 1 on the CTI platform.
5	Wrap-up. The value corresponds to status 6 on the CTI platform.
7	Talking. The value corresponds to states 2, 3, 4, and 5 on the CTI platform.
8	Rest. The value corresponds to status 8 on the CTI platform.