在线系统数据接口
查询企业满意度报表总览
查询 appKey 所属企业的满意度报表总览。请求体必须是 JSON 对象;startTime 或 endTime 任一缺失时,接口默认查询昨天结束的近 30 天。startTime 和 endTime 同时传入时,会校验 endTime 不大于当前时间、startTime 不大于 endTime,并按企业当前限制校验查询跨度。shuntGroup、kefuShunt 为逗号分隔字符串;platforms 为 JSON 字符串。成功响应的 message 字段为满意度总览对象。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| time | any | 是 | 请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败 | |
| checksum | any | 是 | 请求签名校验和 | |
| checksumAlgorithm | integer | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256;不传默认为 0 | |
| appKey | string | 是 | 应用 AppKey |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| startTime | int64 | 否 | 查询开始时间,毫秒时间戳。startTime 或 endTime 任一缺失时,接口默认查询昨天结束的近 30 天。 | 1735660800000 |
| endTime | int64 | 否 | 查询结束时间,毫秒时间戳。与 startTime 同时传入时必须不大于当前时间,且不早于 startTime。 | 1738252799999 |
| sessionOrigin | int32 | 否 | 会话来源过滤:不传或 0 不过滤;1-访客直接访问;其他非 0 值按客服主动发起过滤。 | 0 |
| shuntGroup | string | 否 | 分流组 ID 列表,逗号分隔字符串。空或不传表示不过滤;重复 ID 会被去重。 | 101,102,103 |
| kefuShunt | string | 否 | 客服分流 ID 列表,逗号分隔字符串。空或不传表示不过滤;重复 ID 会被去重。 | 2001,2002 |
| platforms | string | 否 | 平台过滤条件的 JSON 字符串,元素格式为 {"type":"平台类型","value":"平台 ID 或逗号分隔的平台 ID"}。type 支持 web、wx_work、wxkf、wx、open、iOS、harmony、android、wb、wx_ma、wx_sdk、douyin、facebook、line、feishu、dingding、wx_cs、twitter、whatsapp、instagram、discord、wxworkweb、youzan、weimob、xiaohongshu、meituan、wxstore、bilibili、feishu_im、baidu_self_build_site。 | [{"type":"web","value":"1,2"},{"type":"wx","value":""}] |
| isValid | int32 | 否 | 有效会话过滤:不传不过滤;1-仅有效会话;其他非 null 值按无效会话过滤。 | 1 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | object | 满意度总览数据 | |
| └satisfactionRatio | object | 环比指标值 | {"value":0.89,"preValue":0.86} |
| └value | number | 当前值,具体类型由指标决定,可能是整数或小数 | 0.956 |
| └preValue | number | 同期环比值,具体类型由指标决定,可能是整数或小数 | 0.931 |
| └evaCount | int64 | 参评数 | 128 |
| └noEvaluationCount | int64 | 未评数 | 32 |
| └inviteEvaCount | int64 | 邀请评价参评数 | 96 |
| └entryEvaluationCount | int64 | 常驻入口参评数 | 20 |
| └verySatisfiedCount | int64 | 非常满意会话数 | 80 |
| └satisfiedCount | int64 | 满意会话数 | 30 |
| └normalSatisfiedCount | int64 | 一般会话数 | 10 |
| └veryNotSatisfiedCount | int64 | 非常不满意会话数 | 3 |
| └notSatisfiedCount | int64 | 不满意会话数 | 5 |
| └inviteCount | int64 | 邀请评价数 | 160 |
| └staffInviteCount | int64 | 人工邀请评价数 | 70 |
| └autoInviteCount | int64 | 系统邀请评价数 | 90 |
| └userResolvedCount | int64 | 评价已解决数 | 100 |
| └userUnResolvedCount | int64 | 评价未解决数 | 12 |
| └evaRatio | object | 环比指标值 | {"value":0.89,"preValue":0.86} |
| └value | number | 当前值,具体类型由指标决定,可能是整数或小数 | 0.956 |
| └preValue | number | 同期环比值,具体类型由指标决定,可能是整数或小数 | 0.931 |
| └goodEvaCount | object | 环比指标值 | {"value":0.89,"preValue":0.86} |
| └value | number | 当前值,具体类型由指标决定,可能是整数或小数 | 0.956 |
| └preValue | number | 同期环比值,具体类型由指标决定,可能是整数或小数 | 0.931 |
| └badEvaCount | object | 环比指标值 | {"value":0.89,"preValue":0.86} |
| └value | number | 当前值,具体类型由指标决定,可能是整数或小数 | 0.956 |
| └preValue | number | 同期环比值,具体类型由指标决定,可能是整数或小数 | 0.931 |
| └inviteRatio | object | 环比指标值 | {"value":0.89,"preValue":0.86} |
| └value | number | 当前值,具体类型由指标决定,可能是整数或小数 | 0.956 |
| └preValue | number | 同期环比值,具体类型由指标决定,可能是整数或小数 | 0.931 |
| └userResolvedRatio | object | 环比指标值 | {"value":0.89,"preValue":0.86} |
| └value | number | 当前值,具体类型由指标决定,可能是整数或小数 | 0.956 |
| └preValue | number | 同期环比值,具体类型由指标决定,可能是整数或小数 | 0.931 |
| └sessionInCount | int64 | 接入会话量 | 200 |
| └callbackCount | int64 | 坐席发起会话量 | 15 |
| └effectSessionCount | int64 | 有效会话量 | 180 |
| └inviteAfterEvaCount | int64 | 访客评价后客服邀评会话量 | 6 |
| └evaAgainAfterInviteCount | int64 | 访客评价后客服邀评且用户修改评价会话量 | 2 |
| └inviteEvaRatio | double | 被邀参评率;当指标无法计算时可能返回 -2 | 0.6 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 缺失或不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体不是合法 JSON 对象,或无法解析为满意度报表查询参数 |
| 14009 | 频控限制:同一 appKey 对当前接口 60 秒内请求超过 1 次 |
| 14500 | 服务内部异常;time、shuntGroup、kefuShunt、platforms 等参数格式不符合要求或服务处理失败 |
| 14501 | 数据范围错误:endTime 大于当前时间;startTime 大于 endTime;或时间跨度超过限制 |
| 14515 | 当前企业未开通满意度报表权限 |
postEndpoint
/openapi/corp/statistic/satisfaction/reportcurl -X POST "https://qiyukf.com/openapi/corp/statistic/satisfaction/report?time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef&checksumAlgorithm=0&appKey=9f1d7c2b8a6e4d3c" \ -H "Content-Type: application/json" \ -d '{}'{
"code": 200,
"message": {
"satisfactionRatio": {
"value": 0.89,
"preValue": 0.86
},
"evaCount": 128,
"noEvaluationCount": 32,
"inviteEvaCount": 96,
"entryEvaluationCount": 20,
"verySatisfiedCount": 80,
"satisfiedCount": 30,
"normalSatisfiedCount": 10,
"veryNotSatisfiedCount": 3,
"notSatisfiedCount": 5,
"inviteCount": 160,
"staffInviteCount": 70,
"autoInviteCount": 90,
"userResolvedCount": 100,
"userUnResolvedCount": 12,
"evaRatio": {
"value": 0.89,
"preValue": 0.86
},
"goodEvaCount": {
"value": 0.89,
"preValue": 0.86
},
"badEvaCount": {
"value": 0.89,
"preValue": 0.86
},
"inviteRatio": {
"value": 0.89,
"preValue": 0.86
},
"userResolvedRatio": {
"value": 0.89,
"preValue": 0.86
},
"sessionInCount": 200,
"callbackCount": 15,
"effectSessionCount": 180,
"inviteAfterEvaCount": 6,
"evaAgainAfterInviteCount": 2,
"inviteEvaRatio": 0.6
}
}{
"code": 14001,
"message": "AppKey 缺失或不存在"
}{
"code": 14002,
"message": "checksum 校验失败"
}{
"code": 14003,
"message": "请求时间戳与服务器时间误差超过 10 分钟"
}{
"code": 14004,
"message": "请求体不是合法 JSON 对象,或无法解析为满意度报表查询参数"
}{
"code": 14009,
"message": "频控限制:同一 appKey 对当前接口 60 秒内请求超过 1 次"
}{
"code": 14500,
"message": "服务内部异常;time、shuntGroup、kefuShunt、platforms 等参数格式不符合要求或服务处理失败"
}{
"code": 14501,
"message": "数据范围错误:endTime 大于当前时间;startTime 大于 endTime;或时间跨度超过限制"
}{
"code": 14515,
"message": "当前企业未开通满意度报表权限"
}这篇文档有帮助吗?