Updated on 2023-12-19 GMT+08:00

Querying Skill Queues to Which Agents Sign In in Batches

Scenario

This interface is invoked to query skill queues to which specified agents sign in in batches.

Interface Method

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

Internal Encapsulation Interface

CTI3.6: BMS interface: /ccbms/ws/monitor/siteagentcallandskillinfobyagentids

CTI3.8: BMS interface: /ccbms/ws/monitor/queryAgentsLoginSkills

Request URL

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

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

agentIds

Array

Yes

Array of agent IDs. The maximum length of the array is 6000.

The value ranges from 101 to 59999.

Response Description

Table 3 Parameters in the 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.

3

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

skills

Array

Skill queue array of an agent.

For details about the parameters of the object in this array, see Table 5.

Table 5 Parameters of skills

No.

Parameter

Value Type

Description

2.2.1

skillId

Integer

Skill queue ID.

2.2.2

isLogin

Integer

Whether an agent has signed in.

The value 1 indicates that the agent has signed in, and 0 indicates that the agent does not sign in.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • Request parameters
    {
        "ccId":1,
        "vdn":170,
        "agentIds":[1031,1099]
    }
  • Response parameters
    {
        "result": "0",
        "resultCode": "0100000",
        "resultDatas": [
            {
                "skills": [
                    {
                        "skillId": 2,
                        "isLogin": 0
                    }
                ],
                "agentId": 1031
            },
            {
                "skills": [
                    {
                        "skillId": 2,
                        "isLogin": 0
                    },
                    {
                        "skillId": 4,
                        "isLogin": 0
                    }
                ],
                "agentId": 1099
            }
        ],
        "resultDesc": [
            {
                "skills": [
                    {
                        "skillId": 2,
                        "isLogin": 0
                    }
                ],
                "agentId": 1031
            },
            {
                "skills": [
                    {
                        "skillId": 2,
                        "isLogin": 0
                    },
                    {
                        "skillId": 4,
                        "isLogin": 0
                    }
                ],
                "agentId": 1099
            }
        ]
    }