Querying All Calls Queuing in a Skill Queue in Batches

Description

This interface is invoked to query all calls queuing in a skill queue in batches. (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 Interfaces

BMS interfaces:

/ccbms/ws/monitor/querybatchmultiskillqueue
/ccbms/ws/monitor/skillcallqueueinfos

Request URL

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

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

**Table 3** Parameters in the response message body
No.	Parameter	Value Type	Description
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.
2	resultDesc	Array	Object array in the returned result after a successful query. For details about the parameters of this object in the array, see Table 4.

**Table 4** Parameters of resultDesc
No.	Parameter	Value Type	Description
2.1	skillId	Integer	Skill queue ID.
2.2	callPropertyExs	Array	Array of calls queuing in the skill queue. For details about the parameters of this object in the array, see Table 5.

**Table 5** Parameters of callPropertyExs
No.	Parameter	Value Type	Description
2.2.1	callId	String	Call ID.
2.2.2	customerLevel	Integer	Level of the customer making a call. The sequence number ranges from 1 to 254. A larger value indicates the importance of a customer.
2.2.3	requestType	Integer	Call feature. For details, see Table 1.
2.2.4	calling	Array	Calling number.
2.2.5	called	Array	Called number.
2.2.6	mediaType	String	Media type of a call. For details, see Table 1.
2.2.7	orgiCalled	String	Original called number. If the called number changes before the call accesses the system, this parameter records the number of the first called party.
2.2.8	callInTime	Integer	Call arrival time (millisecond-level timestamp).
2.2.9	callPriority	Long	Call priority. For details, see "Configuring Skill Groups" in (For Engineer) ICD VxxxRxxxCxx Product Documentation 01 (ICD).
2.2.10	waitTime	Long	Duration that a call waits in the current queue.
2.2.11	callQueueFlag	Long	Whether the current queue is the main queue of a call. 1: yes 0: no

Message Example

Request header

Content-Type: application/json;charset=UTF-8
Authorization: ******************

Request parameters

{
    "ccId":1,
    "vdn":170,
    "skillIds":[1,2]
}

Response parameters

{
  "resultCode": "0100000",
  "resultDesc": [
    {
      "skillId": 1,
      "callPropertyExs": []
    },
    {
      "skillId": 2,
      "callPropertyExs": [
        {
          "requestType": 0,
          "callPriority": 0,
          "waitTime": 0,
          "callQueueFlag": 1,
          "callId": "1607392439000-379",
          "customerLevel": 0,
          "calling": "1233",
          "called": "34565",
          "mediaType": "MEDIA_TYPE_PHONE",
          "orgiCalled": "234545",
          "callInTime": 1223455666,
        }
      ]
    }
  ]
}

Parent topic: Real-Time Interfaces for Skill Queues

Previous topic: Querying Statistics Details of Skill Queues in Batches

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