Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Historical Data Query/ Obtaining Historical Monitoring Indicators in Specified Month by Agent
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Obtaining Historical Monitoring Indicators in Specified Month by Agent

Scenario

This interface is invoked to obtain historical monitoring indicators in specified month by agent.

Interface Method

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

Request URL

https://ip:port/rest/cmsapp/v1/openapi/hisindex/agentformonth

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

Parameter

Type

Mandatory

Description

ccId

Integer

No

ID of a call center.

  • In the integration environment, the default value is the value of Call Center ID on the Configuration Center > System Management > CMS System Configuration page after a system administrator signs in to the AICC. If this parameter is empty, the data whose sys_key is default_cc_id and sys_type is cms_system_config in the t_cms_sysparam database table is used.
  • In the independent deployment environment, the default value is the value of Default Call Center ID on the Configuration Center > System Management > Parameter Settings page after a system administrator signs in to the AICC.

vdn

Integer

Yes

ID of a VDN.

agentIds

List <Integer>

Yes

Array of agent IDs. The array contains a maximum of 1000 characters. The agent queue is of the integer type, and the value ranges from 0 to 99999.

indexIds

List <String>

Yes

Array of indicators. The indicator is of the string type. The maximum length of the array depends on the number of historical agent monitoring indicators. For details, see Table 1 and Table 3.

beginMonthTime

String

Yes

Start month. The time zone of the VDN is used.

endMonthTime

String

Yes

End month. The time zone of the VDN is used.

mediaType

Integer

No

Call media type. For details, see Table 1.

subMediaType

Integer

No

Submedia type. For details, see Table 1.

Response Message

Table 3 Parameters in the message body

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

List <JSONObject>

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

String

Agent ID.

idxs

List <JSONObject>

Group of indicators.

For details about the parameters of this object, see Table 5.
Table 5 Parameters of idxs

Parameter

Type

Description

id

String

Indicator name.

val

Object

Indicator result.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "ccId":1,
    "vdn":4,
    "agentIds":[11,12],
    "indexIds":["IDX_DURATION_AGENT_REST","IDX_COUNT_AGENT_REQUEST"],
    "beginMonthTime":"202007",
    "endMonthTime":"202008",
    "mediaType":53,
    "subMediaType":3
}
  • Response parameters 
    {
    "resultCode": "0100000",
    "resultDesc": [
        {
            "idxs": [
                {
                    "val": "3",
                    "id": "IDX_COUNT_AGENT_REQUEST"
                },
                {
                    "val": "35",
                    "id": "IDX_DURATION_AGENT_REST"
                }
            ],
            "id": "11"
        },
        {
            "idxs": [
                {
                    "val": "10",
                    "id": "IDX_COUNT_AGENT_REQUEST"
                },
                {
                    "val": "35",
                    "id": "IDX_DURATION_AGENT_REST"
                }
            ],
            "id": "12"
        }
    ]
}
Parent topic: Historical Data Query