Querying Information About the Current Status of All Agents in a Specified VDN

Scenario

This interface is invoked to query information about the current status of all agents in a specified VDN.

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/siteagentinfobyagentids

Request URL

https://ip:port/rest/cmsapp/v1/openapi/vdn/totalagentdynamicinfo

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 request 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	limit	Integer	Yes	Number of query records on each page. The value ranges from 1 to 100.
4	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.

Response Description

**Table 3** Parameters in the response 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	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.
4	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.
5	count	Integer	Total number of agents in the VDN.

**Table 4** Parameters of resultDesc/resultDatas
No.	Parameter	Value Type	Description
2.1	agentId	Integer	Agent ID.
2.2	state	Integer	Agent status. For details, see CTI Platform Agent Status Code Reference.

Message Example

Request header

Content-Type: application/json;charset=UTF-8
Authorization: ******************

Request parameters

{
    "ccId":1, 
    "vdn":170,
    "offset":0,
    "limit":4
}

Response parameters

{
    "result": "0",
    "resultCode": "0100000",
    "count": 30,
    "resultDatas": [
        {
            "agentId": 55002,
            "state": 0
        },
        {
            "agentId": 833,
            "state": 0
        },
        {
            "agentId": 834,
            "state": 0
        },
        {
            "agentId": 835,
            "state": 0
        }
    ],
    "resultDesc": [
        {
            "agentId": 55002,
            "state": 0
        },
        {
            "agentId": 833,
            "state": 0
        },
        {
            "agentId": 834,
            "state": 0
        },
        {
            "agentId": 835,
            "state": 0
        }
    ]
}

Parent topic: Real-Time Interfaces for VDNs

Previous topic: Querying Information About All Agents in a Specified VDN

Next topic: Querying Information About Static Configurations of All Agents in a Specified VDN