通过此接口,可获取接入人工会话数、咨询会话数等与接待人员相关的统计信息
请求方式: POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/get_servicer_statistic?access_token=ACCESS_TOKEN
请求示例
{
"open_kfid": "OPEN_KFID",
"servicer_userid":"zhangsan",
"start_time": 1645545600,
"end_time": 1645632000
}
参数说明:
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 调用接口凭证 |
open_kfid | 是 | string | 客服账号ID |
servicer_userid | 否 | string | 接待人员的userid。第三方应用为密文userid,即open_userid |
start_time | 是 | uint32 | 起始日期的时间戳,填当天的0时0分0秒(否则系统自动处理为当天的0分0秒)。取值范围:昨天至前180天 |
end_time | 是 | uint32 | 结束日期的时间戳,填当天的0时0分0秒(否则系统自动处理为当天的0分0秒)。取值范围:昨天至前180天 |
servicer_userid为非必填参数:
1. 不指定servicer_userid,返回客服账号维度汇总数据;
2. 指定servicer_userid,返回该接待人员在此客服账号下的数据。
查询时间区间[start_time, end_time]为闭区间,最大查询跨度为31天,用户最多可获取最近180天内的数据。当天的数据需要等到第二天才能获取,建议在第二天早上六点以后再调用此接口获取前一天的数据
当传入的时间不为0点时,会向下取整,如传入1554296400(Wed Apr 3 21:00:00 CST 2019)会被自动转换为1554220800(Wed Apr 3 00:00:00 CST 2019);
开启API或授权第三方应用管理会话,没有2022年3月11日以前的统计数据
权限说明:
调用的应用需要满足如下的权限
应用类型 | 权限要求 |
---|---|
自建应用 | 配置到「 微信客服- 可调用接口的应用」中 |
第三方应用 | 具有“微信客服->服务工具->获取客服数据统计”权限 |
代开发自建应用 | 具有“微信客服->服务工具->获取客服数据统计”权限 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"statistic_list" : [
{
"stat_time" : 1645545600,
"statistic" : {
"session_cnt" : 1,
"customer_cnt" : 1,
"customer_msg_cnt" : 1,
"reply_rate" : 1,
"first_reply_average_sec" : 17,
"satisfaction_investgate_cnt" : 1,
"satisfaction_participation_rate" : 1,
"satisfied_rate" : 1,
"middling_rate" : 0,
"dissatisfied_rate" : 0,
"upgrade_service_customer_cnt" : 0,
"upgrade_service_member_invite_cnt" : 0,
"upgrade_service_member_customer_cnt" : 0,
"upgrade_service_groupchat_invite_cnt" : 0,
"upgrade_service_groupchat_customer_cnt" : 0,
"msg_rejected_customer_cnt" : 1
}
},
{
"stat_time" : 1645632000,
"statistic" : {
...
}
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 错误码描述 |
statistic_list | obj | 统计数据列表 |
statistic_list.stat_time | uint32 | 数据统计日期,为当日0点的时间戳 |
statistic_list.statistic | obj | 一天的统计数据。若当天未产生任何下列统计数据或统计数据还未计算完成则不会返回此项 |
statistic_list.statistic.session_cnt | uint64 | 接入人工会话数。客户发过消息并分配给接待人员的咨询会话数 |
statistic_list.statistic.customer_cnt | uint64 | 咨询客户数。在会话中发送过消息且接入了人工会话的客户数量,若客户多次咨询只计算一个客户 |
statistic_list.statistic.customer_msg_cnt | uint64 | 咨询消息总数。客户在会话中发送的消息的数量 |
statistic_list.statistic.reply_rate | float | 人工回复率。一个自然日内,客户给接待人员发消息的会话中,接待人员回复了的会话的占比。若数据项不返回,代表没有给接待人员发送消息的客户,此项无法计算。 |
statistic_list.statistic.first_reply_average_sec | float | 平均首次响应时长,单位:秒。一个自然日内,客户给接待人员发送的第一条消息至接待人员回复之间的时长,为首次响应时长。所有的首次回复总时长/已回复的咨询会话数,即为平均首次响应时长 。若数据项不返回,代表没有给接待人员发送消息的客户,此项无法计算 |
statistic_list.statistic.satisfaction_investgate_cnt | uint64 | 满意度评价发送数。当api托管了会话分配,满意度原生功能失效,满意度评价发送数为0 |
statistic_list.statistic.satisfaction_participation_rate | float | 满意度参评率 。当api托管了会话分配,满意度原生功能失效。若数据项不返回,代表没有发送满意度评价,此项无法计算 |
statistic_list.statistic.satisfied_rate | float | “满意”评价占比 。在客户参评的满意度评价中,评价是“满意”的占比。当api托管了会话分配,满意度原生功能失效。若数据项不返回,代表没有客户参评的满意度评价,此项无法计算 |
statistic_list.statistic.middling_rate | float | “一般”评价占比 。在客户参评的满意度评价中,评价是“一般”的占比。当api托管了会话分配,满意度原生功能失效。若数据项不返回,代表没有客户参评的满意度评价,此项无法计算 |
statistic_list.statistic.dissatisfied_rate | float | “不满意”评价占比。在客户参评的满意度评价中,评价是“不满意”的占比。当api托管了会话分配,满意度原生功能失效。若数据项不返回,代表没有客户参评的满意度评价,此项无法计算 |
statistic_list.statistic.upgrade_service_customer_cnt | uint64 | 升级服务客户数。通过「升级服务」功能成功添加专员或加入客户群的客户数,若同一个客户添加多个专员或客户群,只计算一个客户。在2022年3月10日以后才会有对应统计数据 |
statistic_list.statistic.upgrade_service_member_invite_cnt | uint64 | 专员服务邀请数。接待人员通过「升级服务-专员服务」向客户发送服务专员名片的次数。在2022年3月10日以后才会有对应统计数据 |
statistic_list.statistic.upgrade_service_member_customer_cnt | uint64 | 添加专员的客户数 。客户成功添加专员为好友的数量,若同一个客户添加多个专员,则计算多个客户数。在2022年3月10日以后才会有对应统计数据 |
statistic_list.statistic.upgrade_service_groupchat_invite_cnt | uint64 | 客户群服务邀请数。接待人员通过「升级服务-客户群服务」向客户发送客户群二维码的次数。在2022年3月10日以后才会有对应统计数据 |
statistic_list.statistic.upgrade_service_groupchat_customer_cnt | uint64 | 加入客户群的客户数。客户成功加入客户群的数量,若同一个客户加多个客户群,则计算多个客户数。在2022年3月10日以后才会有对应统计数据 |
statistic_list.statistic.msg_rejected_customer_cnt | uint64 | 被拒收消息的客户数。被接待人员设置了“不再接收消息”的客户数 |