Interface for Querying CTI System Indicators

Updated on 2023-12-19 GMT+08:00

View PDF

Prerequisites

This interface is invoked only for global AK/SK authentication.

Note: This interface supports only the independent deployment environment.

Description

This interface is invoked to query CTI system indicators.

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/cti/sysindex

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	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
Parameter	Type	Mandatory	Description
ccId	Integer	No	ID of a call center. 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	list	No	Array of VDN IDs. The maximum length of the array is 100.
beginDate	String	Yes	Query start time. The UTC time zone is used. The interval between the start time and end time cannot exceed 31 days (rounded up).
endDate	String	Yes	Query end time. The UTC time zone is used.
limit	Integer	No	This parameter is optional. The default value is 100.
offset	Integer	No	This parameter is optional. The default value is 0.

Response Message

**Table 3** Parameters in the response 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	Object list in the returned result after a successful query. For details about the parameters of the object, see the following table.

**Table 4** Parameters of resultDesc
Parameter	Type	Description
beginTime	String	Statistics start time, which is a timestamp in milliseconds (start time of a 5-minute statistical period).
ccId	Integer	ID of a call center.
vdn	Integer	ID of a VDN.
onlineAgentNums	Integer	Number of online agents (including agents who do not answer inbound calls).
talkingNums	Integer	Number of talking agents (excluding the agents who do not answer inbound calls).
ideaAgentNum	Integer	Number of idle agents (excluding agents who do not answer inbound calls).
busyNums	Integer	Number of agents who indicate busy (excluding the number of agents who do not answer inbound calls).
restNums	Integer	Number of agents who take a rest (excluding agents who do not answer inbound calls).
incallNums	Integer	Number of inbound calls within five minutes.
rateNum	Integer	Number of manual inbound calls connected within 5 minutes.
callRate	Integer	Manual inbound call connection rate within 5 minutes.
callOutNums	Integer	Number of outbound calls within five minutes.

Message Example

Request header

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

Request parameters

{
    "ccId":1,
    "vdn":[1,2,3],
    "beginDate":"2021-09-09 00:00:00",
    "endDate":"2021-09-11 23:00:00",
    "limit":"100",
    "offset":"0"
}

Response parameters

{
    "resultCode": 0,
    "resultDesc": {
    "data": [
    {
        "beginTime": "1631594100000",
        "ccId": 1,
        "vdn": 1,
        "onlineAgentNums": 1,
        "talkingNums": 1,
        "ideaAgentNum": 1,
        "busyNums": 1,
        "restNums": 1,
        "inCallNums": 1,
        "rateNum": 1,
        "callRate": 1,
        "callOutNums": 1
    }
    ],
        "count": 6
    }
}

Parent topic: Interfaces for Querying System Indicators

Previous topic: Interface for Querying UAP Terminal Statistics

Next topic: Querying the Time of the CTI Platform Server