NXCC API agentEfficiencyStatistics

• Query seat status information

  • URL：https://api2.nxcloud.com/saas/cc/openapi/agent/efficiencyStatistical/page
  • Method：POST
  • Content-Type：application/json
  • Required：yes

Authentication Mechanism

For authentication rules, please refer to: API Interface Call Agreement

Request Parameters

header：

Parameter Name	Type	Required	Example Value	Description
accessKey	String	Y	fme2na3kdi3ki	User identity identifier
ts	String	Y	1655710885431	Timestamp of the current request (in milliseconds). The NX server allows a maximum time error of 60 seconds for client requests.
bizType	String	Y	8	Business type, fixed value “8”
action	String	Y	cc	Business operation, fixed value “cc”
sign	String	Y	6e9506557d1f289501d333ee2c365826	API parameter signature, Signature Algorithm

body ：

Parameter Name	Type	Required	Example Value	Description
userName	String	否	0	User account (email or account starting with NX)
groupName	String	否		Agent group name
tenantId	Long	否		Team ID (can be queried on nxlink)
staticalType	enum	是	0	Statistical type: 0: Total, 1: By day
startDateTime	String	是	2024-01-22 00:00:00	Start time
endDateTime	String	是	2024-01-22 23:59:59	End time
size	Integer	是	100	Page size (maximum 100)
page	Integer	是	1	Page number (starting from 1)

Request Example

body（application/json）：

{
  "userName": "NXAgent0001",
  "groupName": "NXGroup0001"
  "tenantId": 144,
  "staticalType": 0,
  "size": 20,
  "page": 1,
  "startDateTime":"2024-01-08 00:00:00",
  "endDateTime":"2024-01-08 23:59:59"
}

Response Parameters

name	type	Description
code	Integer	Result code
data	Object	Request result
msg	String	Request description
total	Integer	Total

Successful Request

• data parameters:

Name	Type	Description
agentName	string	Agent account
agentNickName	string	Agent nickname
answerCountInFive	integer(int32)	Number of responses within 5 seconds
answerCountInTen	integer(int32)	Number of responses within 10 seconds
answerCountInTwenty	integer(int32)	Number of responses within 20 seconds
calcDay	string(date-time)	Statistical date
evaluateCount	integer(int32)	Number of customer evaluations
groupName	string	Agent group name
inAgentNoanswerCount	integer(int32)	Number of unanswered incoming calls (agent didn't answer)
inAnswerCount	integer(int32)	Number of answered incoming calls
inAnswerRatio	string	Incoming call answer rate
inAnswerRingAvgTime	integer(int32)	Average answer speed (sum of answer times ÷ number of calls)
inCallDuration	integer(int32)	Total duration of incoming calls
inCallDurationAvgTime	integer(int32)	Average duration of incoming calls
inCount	integer(int32)	Number of incoming calls
inNoanswerCount	integer(int32)	Number of unanswered incoming calls
inRingCount	integer(int32)	Number of incoming ring calls
inRingDuration	integer(int32)	Total duration of incoming rings
inRingRate	string	Incoming call ring rate (number of answered calls ÷ number of rings)
inUserNoanswerCount	integer(int32)	Number of unanswered incoming calls (user abandoned)
outAnswerCount	integer(int32)	Number of answered outgoing calls
outAnswerRatio	string	Outgoing call answer rate (number of answered calls ÷ number of outgoing calls)
outCallDuration	integer(int32)	Total duration of outgoing calls
outCallDurationAvgTime	integer(int32)	Average duration of outgoing calls
outCount	integer(int32)	Number of outgoing calls
outNoanswerCount	integer(int32)	Number of unanswered outgoing calls
satisfiedAndVerySatisfiedCount	integer(int32)	Number of very satisfied and satisfied customers
dissatisfiedCount	integer(int32)	Number of dissatisfied customers
satisfiedAndVerySatisfiedRate	string	Customer satisfaction rate (number of very satisfied and satisfied customers ÷ number of evaluations)

Response Example

Success Example

{ "reqId": "a23738fb613d889026fa2c8f4e4378f1", "code": 0, "msg": "success", "data": [ { "agentName": "string", "agentNickName": "string", "answerCountInFive": 0, "answerCountInTen": 0, "answerCountInTwenty": 0, "calcDay": "2019-08-24 14:15:22", "evaluateCount": 0, "groupName": "string", "inAgentNoanswerCount": 0, "inAnswerCount": 0, "inAnswerRatio": "string", "inAnswerRingAvgTime": 0, "inCallDuration": 0, "inCallDurationAvgTime": 0, "inCount": 0, "inNoanswerCount": 0, "inRingCount": 0, "inRingDuration": 0, "inRingRate": "string", "inUserNoanswerCount": 0, "outAnswerCount": 0, "outAnswerRatio": "string", "outCallDuration": 0, "outCallDurationAvgTime": 0, "outCount": 0, "outNoanswerCount": 0, "dissatisfiedCount": 0, "satisfiedAndVerySatisfiedCount": 0, "satisfiedAndVerySatisfiedRate": "string" } ] }

Failure Example

{
  "reqId": "FFDD1791E22F4D9DBA967C245C58E544",
  "code": 1001,
  "msg": "Authorization Failed",
  "data": {},
  "total": 0   
}

Response Code Description

code	message	Resolution
0	Request successful
88	Request failed	Please contact technical support to resolve the issue
99	System error	Please contact technical support to resolve the issue
1000~100X	Authentication failed	See the API Authentication section for details