在线系统数据接口
总览头部数据
查询总览头部统计数据,支持按客服、分流组、分流客服筛选。时间范围不超过 31 天(可配置),默认查询近 30 天。distributeIds/distributeStaffIds 与 staffIds 互斥。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| startTime | int64 | 否 | 开始时间(毫秒时间戳),不传默认 30 天前 | 1685548800000 |
| endTime | int64 | 否 | 结束时间(毫秒时间戳),不传默认昨天 23:59:59 | 1688140799000 |
| staffIds | int64[] | 否 | 客服 ID 列表(与 distributeIds/distributeStaffIds 互斥) | |
| sessionOrigin | int32 | 否 | 会话发起方,0-全部 | 0 |
| distributeIds | int64[] | 否 | 分流组 ID 列表(与 staffIds 互斥) | |
| distributeStaffIds | int64[] | 否 | 分流客服 ID 列表(与 staffIds 互斥) |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | object | 在线系统总览头部统计数据 | |
| └sessions | int64 | 总会话数 | 10 |
| └effectSessions | int64 | 有效会话数 | 10 |
| └assignedRatio | double | 接入率 | 0.85 |
| └effectAssignedRatio | double | 有效接入率 | 0.85 |
| └redirectSessionsCount | int64 | 转接会话量 | 10 |
| └realSessionInRatio | double | 实际接入率 | 0.85 |
| └messages | int64 | 总消息数 | 10 |
| └answerRatio | double | 问答比 | 0.85 |
| └specialAnswerRatio | double | 30 秒内应答率 | 0.85 |
| └specialAnswer45Ratio | double | 45 秒内应答率 | 0.85 |
| └evaFromCount | int64 | 邀评数 | 10 |
| └evaFromRatio | double | 邀评率 | 0.85 |
| └satisfactionRatio | double | 相对满意度 | 0.85 |
| └relativelySatisfiedCount | int64 | 相对满意会话数 | 10 |
| └relativelySatisfiedAll | int64 | 相对满意度统计总数 | 10 |
| └responseTotalLength | int64 | 响应总时长 | 60000 |
| └responseTotalLengthAll | int64 | 响应时长统计回合数 | 60000 |
| └answerThirtyRatioCount | int64 | 30 秒应答会话数 | |
| └answerThirtyRatioAll | int64 | 30 秒应答率统计总数 | |
| └sessionLength | int64 | 会话总时长 | 60000 |
| └sessionLengthAll | int64 | 会话时长统计总数 | 60000 |
| └evaluatedCount | int64 | 已评价会话数 | 10 |
| └evaluatedCountAll | int64 | 评价统计总数 | 10 |
| └firstResponseTimeCount | int64 | 首次响应总时长 | 1720087200000 |
| └firstResponseTimeAll | int64 | 首次响应统计总数 | 1720087200000 |
| └avgSucQueueTimeCount | int64 | 成功接入排队总时长 | 1720087200000 |
| └avgSucQueueTimeAll | int64 | 成功接入排队统计总数 | 1720087200000 |
| └evaRatio | double | 参评率 | 0.85 |
| └avgTime | int64 | 平均会话时长 | 1720087200000 |
| └avgRgTime | int64 | 平均人工接待时长 | 1720087200000 |
| └avgFirstRespTime | int64 | 平均首次响应时长 | 1720087200000 |
| └avgRespTime | int64 | 平均响应时长 | 1720087200000 |
| └queueCount | int64 | 排队次数 | 10 |
| └avgSucQueueTime | int64 | 平均成功排队时长 | 1720087200000 |
| └maxQueueTime | int64 | 最长排队时长 | 1720087200000 |
| └unAssignedSessions | int64 | 未接入会话数 | 10 |
| └avgFailureQueueTime | int64 | 平均放弃排队时长 | 1720087200000 |
| └oneOffRatio | double | 一次解决率 | 0.85 |
| └userResolvedRatio | double | 用户问题解决率 | 0.85 |
| └userResolvedCount | int64 | 用户反馈已解决数量 | 10 |
| └userUnResolvedCount | int64 | 用户反馈未解决数量 | 10 |
| └queueCountMessage | int64 | 排队转留言数量 | 10 |
| └visit | int64 | 总来访量 | 10 |
| └sessionInCount | int64 | 接入会话量 | 10 |
| └sessionNotInCount | int64 | 未接入会话量 | 10 |
| └callBackCount | int64 | 客服主动发起会话量 | 10 |
| └notInServiceCount | int64 | 非服务时间来访量 | 10 |
| └slientTransCount | int64 | 系统转出量 | 10 |
| └humanTransCount | int64 | 人工转出量 | 10 |
| └overflowCount | int64 | 系统溢出量 | 10 |
| └evaInviteRatio | double | 会话邀评率 | 0.85 |
| └validInviteEvalPercent | double | 有效会话邀评率 | 0.85 |
| └einsteinTransCount | int64 | 机器人转人工会话量 | 10 |
| └einsteinCount | int64 | 机器人会话量 | 10 |
| └totalConsultCount | int64 | 总咨询来访量 | 10 |
| └sessionInviteCount | int64 | 会话邀请量 | 10 |
| └sessionInviteSuccessCount | int64 | 会话邀请成功量 | 10 |
| └sessionInviteRatio | double | 会话邀请成功率 | 0.85 |
| └loginStaffCount | int64 | 登录客服账号数 | 10 |
| └resumeDuration | double | 在线总时长 | 0.85 |
| └robotHostingSessionCount | int64 | 机器人托管会话量 | 10 |
| └robotHostingSessionRatio | double | 机器人托管会话占比 | 0.85 |
| └avgRobotHostingDuration | int64 | 平均机器人托管时长,单位秒 | |
| └robotHostingAlertTriggeredSessionCount | int64 | 触发转人工提醒的会话量 | 10 |
| └einsteinTransValidCount | int64 | 机器人有效转人工会话量 | 10 |
| └einsteinValidCount | int64 | 机器人有效会话量 | 10 |
| └carrier | object | 扩展指标载体 | {"示例":1} |
| └userMessages | int64 | 用户消息数 | 10 |
| └staffMessages | int64 | 客服消息数 | 10 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体 JSON 格式错误;参数互斥冲突 |
| 14500 | 服务内部异常 |
| 14501 | 时间范围超过限制(>31 天);结束时间不合法 |
postEndpoint
/openapi/statistic/overviewcurl -X POST "https://qiyukf.com/openapi/statistic/overview?appKey=string&time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef" \ -H "Content-Type: application/json" \ -d '{}'{
"code": 200,
"message": {
"sessions": 10,
"effectSessions": 10,
"assignedRatio": 0.85,
"effectAssignedRatio": 0.85,
"redirectSessionsCount": 10,
"realSessionInRatio": 0.85,
"messages": 10,
"answerRatio": 0.85,
"specialAnswerRatio": 0.85,
"specialAnswer45Ratio": 0.85,
"evaFromCount": 10,
"evaFromRatio": 0.85,
"satisfactionRatio": 0.85,
"relativelySatisfiedCount": 10,
"relativelySatisfiedAll": 10,
"responseTotalLength": 60000,
"responseTotalLengthAll": 60000,
"answerThirtyRatioCount": 0,
"answerThirtyRatioAll": 0,
"sessionLength": 60000,
"sessionLengthAll": 60000,
"evaluatedCount": 10,
"evaluatedCountAll": 10,
"firstResponseTimeCount": 1720087200000,
"firstResponseTimeAll": 1720087200000,
"avgSucQueueTimeCount": 1720087200000,
"avgSucQueueTimeAll": 1720087200000,
"evaRatio": 0.85,
"avgTime": 1720087200000,
"avgRgTime": 1720087200000,
"avgFirstRespTime": 1720087200000,
"avgRespTime": 1720087200000,
"queueCount": 10,
"avgSucQueueTime": 1720087200000,
"maxQueueTime": 1720087200000,
"unAssignedSessions": 10,
"avgFailureQueueTime": 1720087200000,
"oneOffRatio": 0.85,
"userResolvedRatio": 0.85,
"userResolvedCount": 10,
"userUnResolvedCount": 10,
"queueCountMessage": 10,
"visit": 10,
"sessionInCount": 10,
"sessionNotInCount": 10,
"callBackCount": 10,
"notInServiceCount": 10,
"slientTransCount": 10,
"humanTransCount": 10,
"overflowCount": 10,
"evaInviteRatio": 0.85,
"validInviteEvalPercent": 0.85,
"einsteinTransCount": 10,
"einsteinCount": 10,
"totalConsultCount": 10,
"sessionInviteCount": 10,
"sessionInviteSuccessCount": 10,
"sessionInviteRatio": 0.85,
"loginStaffCount": 10,
"resumeDuration": 0.85,
"robotHostingSessionCount": 10,
"robotHostingSessionRatio": 0.85,
"avgRobotHostingDuration": 0,
"robotHostingAlertTriggeredSessionCount": 10,
"einsteinTransValidCount": 10,
"einsteinValidCount": 10,
"carrier": {
"示例": 1
},
"userMessages": 10,
"staffMessages": 10
}
}{
"code": 14001,
"message": "AppKey 不存在"
}{
"code": 14002,
"message": "checksum 校验失败"
}{
"code": 14003,
"message": "请求时间戳与服务器时间误差超过 10 分钟"
}{
"code": 14004,
"message": "请求体 JSON 格式错误;参数互斥冲突"
}{
"code": 14500,
"message": "服务内部异常"
}{
"code": 14501,
"message": "时间范围超过限制(>31 天);结束时间不合法"
}这篇文档有帮助吗?
查询企业满意度报表总览
查询 appKey 所属企业的满意度报表总览。请求体必须是 JSON 对象;startTime 或 endTime 任一缺失时,接口默认查询昨天结束的近 30 天。startTime 和 endTime 同时传入时,会校验 endTime 不大于当前时间、startTime 不大于 endTime,并按企业当前限制校验查询跨度。shuntGroup、kefuShunt 为逗号分隔字符串;platforms 为 JSON 字符串。成功响应的 message 字段为满意度总览对象。
订单绩效统计
查询订单绩效统计数据,支持按客服组、客服筛选和排序。时间范围不超过 365 天。需同时传 startTime 和 endTime 或都不传(默认近 30 天)。pageSize 上限 1000。