Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Configuration Data Query/ Querying Information About All Agents by VDN ID
Updated on 2023-12-19 GMT+08:00
View PDF

Querying Information About All Agents by VDN ID

Scenario

This interface is invoked to query information about all agents by VDN ID. A tenant corresponds to a VDN after being created and configured.

Interface Method

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

Internal Encapsulation Interface

BMS interface: /ccbms/ws/monitor/siteagentcallandskillinfobyagentids

Request URL

https://ip:port/rest/cmsapp/v1/openapi/configures/agents/{ccId}/{vdn}/{offset}/{limit}

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. {ccId} indicates the call center ID, ranging from 1 to 65535; {vdn} indicates the VDN ID, ranging from 1 to 5000; {offset} indicates the start offset (optional); and {limit} indicates the number of records to be queried on each page (optional, and the maximum value is 100). {offset} and {limit} must be transferred at the same time.

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.

Response Description

Table 2 Parameters in the response message body

Parameter

Value 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.

NOTE:

This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.

resultCode

String

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

For details about the failure causes, see Error Code Reference.

count

Integer

Total number of agents. This parameter is returned only when {offset} and {limit} in the request take effect.

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 3.

NOTE:

This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.

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 3.
Table 3 Parameters of resultDesc/resultDatas

Parameter

Value Type

Description

agentNo

String

Agent ID.

agentName

String

Agent name.

roleId

String

Agent role.

skillId

String

Skill ID set. Multiple skill IDs are separated by semicolons (;), for example, 1;3;10;11;25;31;32;40.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters

    None

  • Response parameters
    {
    "result": "0",
    "resultCode": "0100000",
    "count": 101,
    "resultDatas": [
        {
            "agentNo": "10000",
            "agentName": "z1",
            "roleId": "1",
            "skillId": ""
        },
        {
            "agentNo": "101",
            "agentName": "z2",
            "roleId": "1",
            "skillId": "2;3"
        }
    ],
    "resultDesc": [
        {
            "agentNo": "10000",
            "agentName": "z1",
            "roleId": "1",
            "skillId": ""
        },
        {
            "agentNo": "101",
            "agentName": "z2",
            "roleId": "1",
            "skillId": "2;3"
        }
    ]
}
Parent topic: Configuration Data Query