Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Real-Time Data Query/ Real-Time Interfaces for VDNs/ Querying Static Configuration Information About All Agents in a Specified VDN (Not Supported by CTI 3.6)
Updated on 2023-12-19 GMT+08:00
View PDF
Share

Querying Static Configuration Information About All Agents in a Specified VDN (Not Supported by CTI 3.6)

Scenario

This interface is invoked to query static configuration information about all agents in a specified VDN. Pagination is not supported. (CTI 3.6 does not support this interface.)

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

Request URL

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

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.

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

No.

Parameter

Value Type

Description

2.1

agentId

Integer

Agent ID.

2.2

groupId

Integer

Agent group ID.

Group: To facilitate the management of agents, the agents of a VDN are usually grouped. Agents in a group form an agent group.

2.3

rights

String

Permission value of an agent. The value 0 indicates that the agent has no permission, and 1 indicates that the agent has permission. Table 5 describes the role permission.

2.4

name

String

Agent name.

2.5

realFlag

Integer

Whether an agent is a network agent. The value 0 indicates network agent, and 1 indicates common agent. Currently, all agents in the AICC are common agents.
Table 5 Agent permission value

Bit

Description

1

Showing busy/idle.

2

Muting/Unmuting calls.

3

Holding/Unholding calls.

4

Connecting held calls.

5

Common outbound call.

6

Internal call.

7

Transferring calls internally.

8

Answering transferred inbound calls.

9

Making three-party calls.

10

Transferring out calls.

11

Transferring calls from the agent service to automatic service.

12

Rejecting inbound calls.

13

Listening/Listening and inserting/Whispering.

14

Intercepting calls.

15

Forcibly signing out/Forcibly showing busy/Forcibly showing idle.

16

Inspecting recordings/Inspecting voice playing.

17

Monitoring inspections.

18

Appraisal administrator.

19

Ordinary appraisal personnel.

20

Alarm console.

21

Report handler.

22

Reserved value.

23

Monitoring console.

24

Configuration administrator.

25

Report administrator.

26

Making national outbound toll calls.

27

Making international outbound toll calls.

28

Making outbound calls using access codes of the call center.

29

Performing inspections in fullscreen mode.

30

Picking up calls for the agents in the same agent group.

31

Reserved value.

32

Configuring agents.

33~256

Reserved value.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "ccId":1, 
    "vdn":170
}
  • Response parameters 
    {
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "agentId": 1086,
            "groupId": -1,
            "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
            "name": "HW285601086",
            "realFlag": 1
        },
        {
            "agentId": 1087,
            "groupId": -1,
            "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
            "name": "HW285601087",
            "realFlag": 1
        }
    ],
    "resultDesc": [
        {
            "agentId": 1086,
            "groupId": -1,
            "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
            "name": "HW285601086",
            "realFlag": 1
        },
        {
            "agentId": 1087,
            "groupId": -1,
            "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]",
            "name": "HW285601087",
            "realFlag": 1
        }
    ]
}