Querying the Number of Calls that Each Queue Answers from Other Queues in Batches When Calls are Queuing in Multiple Skill Queues

Scenario

This interface is invoked to query the number of calls that each queue answers from other queues in batches when calls are queuing in multiple skill queues.

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

Request URL

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

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.
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	skillId	Integer	Skill queue ID.
2.2	overloadDetails	Array	Details about the number of calls in other queues. For details about the parameters of the object in this array, see Table 5.

**Table 5** Parameter description of overloadDetails
No.	Parameter	Value Type	Description
2.2.1	queueId	Integer	Skill queue ID.
2.2.2	callNum	Long	Number of answered calls.

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,
            "overloadDetails": [
                {
                    "queueId": 2,
                    "callNum": 1
                }
            ]
        },
        {
            "skillId": 2,
            "overloadDetails": []
        }
    ],
    "resultDesc": [
        {
            "skillId": 1,
            "overloadDetails": [
                {
                    "queueId": 2,
                    "callNum": 1
                }
            ]
        },
        {
            "skillId": 2,
            "overloadDetails": []
        }
    ]
}

Parent topic: Real-Time Interfaces for Skill Queues

Previous topic: Querying All Calls Queuing in a Skill Queue in Batches

Next topic: Querying the Number of Agents in Each State in a Skill Group