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 Skill Queues/ Querying Information About Skill Queue Configurations in Batches
Updated on 2023-12-19 GMT+08:00
View PDF
Share

Querying Information About Skill Queue Configurations in Batches

Scenario

This interface is invoked to query information about skill queue configurations in batches.

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

Request URL

https://ip:port/rest/cmsapp/v1/openapi/skill/skillcfginfo

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

skillIds

Array

Yes

Object array of skill queue ID information.

The array cannot exceed 1000 characters.

The value ranges from 1 to 2000.

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.

1

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.

2

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

skillId

Integer

Skill queue ID.

2.2

maxCallNum

Integer

Maximum number of queuing calls.

2.3

maxHoldCallNum

Integer

Maximum number of held calls.

2.4

maxWaitTime

Long

Maximum waiting duration, in seconds.

2.5

maxAnswerWaitTime

Long

Maximum ringing duration, in seconds.

2.6

maxTalkTime

Long

Maximum call duration, in seconds.

2.7

maxRestAgentNum

Integer

Maximum number of agents that are allowed to have a rest.

2.8

maxAgentWrapupTime

Integer

Maximum agent wrap-up duration, in seconds.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "ccId":1,
    "vdn":170,
    "skillIds":[1,2]
}
  • Response parameters 
    {
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "skillId": 1,
            "maxHoldCallNum": 5,
            "maxTalkTime": 86400,
            "maxAgentWrapupTime": 5,
            "maxWaitTime": 60,
            "maxRestAgentNum": 2,
            "maxCallNum": 100,
            "maxAnswerWaitTime": 30
        },
        {
            "skillId": 2,
            "maxHoldCallNum": 5,
            "maxTalkTime": 86400,
            "maxAgentWrapupTime": 5,
            "maxWaitTime": 60,
            "maxRestAgentNum": 2,
            "maxCallNum": 100,
            "maxAnswerWaitTime": 30
        }
    ],
    "resultDesc": [
        {
            "skillId": 1,
            "maxHoldCallNum": 5,
            "maxTalkTime": 86400,
            "maxAgentWrapupTime": 5,
            "maxWaitTime": 60,
            "maxRestAgentNum": 2,
            "maxCallNum": 100,
            "maxAnswerWaitTime": 30
        },
        {
            "skillId": 2,
            "maxHoldCallNum": 5,
            "maxTalkTime": 86400,
            "maxAgentWrapupTime": 5,
            "maxWaitTime": 60,
            "maxRestAgentNum": 2,
            "maxCallNum": 100,
            "maxAnswerWaitTime": 30
        }
    ]
}