Obtaining Real-Time Monitoring Indicators by Skill Queue

Description

This interface is invoked to obtain real-time monitoring indicators by skill queue.

Interface Method

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

Internal Encapsulation Interfaces

BMS interface: /ccbms/ws/monitor/rindexSkill

Request URL

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

In the URL, 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	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** Parameter description
Parameter	Type	Mandatory	Description
ccId	Integer	Yes	ID of a call center. The value ranges from 1 to 65535.
vdn	Integer	Yes	ID of a VDN. The value ranges from 1 to 5000.
skillIds	Array	Yes	Object array of skill queue ID information. The array cannot exceed 1000 characters. The value ranges from 1 to 2000.
indexIds	Array	Yes	Array of indicators. The maximum length of the array depends on the number of real-time monitoring indicators by skill. The maximum value is 12 currently. For details about the parameters of this object, see Table 2.

Response Message

**Table 3** Parameter description
Parameter	Type	Description
resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
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
Parameter	Type	Description
id	Integer	Skill queue ID.
idxs	Array	Group of indicators. For details about the parameters of this object, see Table 5.

**Table 5** Parameter description of idxs
Parameter	Type	Description
id	String	Indicator ID.
val	Object	Indicator result. For details about the parameters of this object, see Table 2.

Message Example

Request header

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

Request parameters

{
    "ccId":1,
    "vdn":170,
    "skillIds":[1,2],
    "indexIds":["IDX_COUNT_REAL_SKILL_QUEUE","IDX_COUNT_REAL_SKILL_HANDLE","IDX_DURATION_SKILL_MAX_QUEUE_ACK",
    "IDX_COUNT_20S_CALL_FOR_5MIN","IDX_COUNT_REAL_AGENT_SIGN_IN","IDX_COUNT_REAL_AGENT_CONNECT",
    "IDX_COUNT_REAL_AGENT_SET_IDLE","IDX_COUNT_REAL_AGENT_USABLE","IDX_COUNT_REAL_AGENT_SET_BUSY",
    "IDX_COUNT_REAL_AGENT_ACW","IDX_COUNT_REAL_AGENT_REST","IDX_COUNT_REAL_AGENT_STUDY"]

}

Response parameters

{
  "resultCode": "0100000",
  "resultDesc": [
    {
      "id": "1",
      "idxs": [
        {
          "id": "IDX_COUNT_REAL_SKILL_QUEUE",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_SKILL_HANDLE",
          "val": "0"
        },
        {
          "id": "IDX_DURATION_SKILL_MAX_QUEUE_ACK",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_20S_CALL_FOR_5MIN",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_SIGN_IN",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_CONNECT",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_SET_IDLE",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_USABLE",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_SET_BUSY",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_ACW",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_REST",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_STUDY",
          "val": "0"
        }
      ]
    },
    {
      "id": "2",
      "idxs": [
        {
          "id": "IDX_COUNT_REAL_SKILL_QUEUE",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_SKILL_HANDLE",
          "val": "0"
        },
        {
          "id": "IDX_DURATION_SKILL_MAX_QUEUE_ACK",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_20S_CALL_FOR_5MIN",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_SIGN_IN",
          "val": "1"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_CONNECT",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_SET_IDLE",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_USABLE",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_SET_BUSY",
          "val": "1"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_ACW",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_REST",
          "val": "0"
        },
        {
          "id": "IDX_COUNT_REAL_AGENT_STUDY",
          "val": "0"
        }
      ]
    }
  ]
}

Parent topic: Real-Time Interfaces for Skill Queues

Previous topic: Querying Service Quality for Skill Queues in Batches

Next topic: Real-Time Interfaces for Agents