获取「客户数据统计」企业汇总数据 - 文档

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

服务端API

微信客服

统计管理

获取「客户数据统计」企业汇总数据

最后更新：2023/11/30

通过此接口，可以获取咨询会话数、咨询客户数等企业汇总统计数据

请求方式: POST(HTTPS)

请求地址: https://qyapi.weixin.qq.com/cgi-bin/kf/get_corp_statistic?access_token=ACCESS_TOKEN

请求示例

{
    "open_kfid": "OPEN_KFID",
    "start_time": 1645545600,
	"end_time": 1645632000
}

参数说明:

参数	必须	类型	说明
access_token	是	string	调用接口凭证
open_kfid	是	string	客服账号ID
start_time	是	uint32	起始日期的时间戳，填这一天的0时0分0秒（否则系统自动处理为当天的0分0秒）。取值范围：昨天至前180天
end_time	是	uint32	结束日期的时间戳，填这一天的0时0分0秒（否则系统自动处理为当天的0分0秒）。取值范围：昨天至前180天

查询时间区间[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" : 2,
                    "customer_cnt" : 1,
                    "customer_msg_cnt" : 6,
                    "upgrade_service_customer_cnt" : 0,
                    "ai_session_reply_cnt" : 1,
                    "ai_transfer_rate" : 1,
                    "ai_knowledge_hit_rate" : 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.upgrade_service_customer_cnt	uint64	升级服务客户数。通过「升级服务」功能成功添加专员或加入客户群的客户数，若同一个客户添加多个专员或客户群，只计算一个客户。在2022年3月10日以后才会有对应统计数据
statistic_list.statistic.ai_session_reply_cnt	uint64	智能回复会话数。客户发过消息并分配给智能助手的咨询会话数。通过API发消息或者开启智能回复功能会将客户分配给智能助手
statistic_list.statistic.ai_transfer_rate	float	转人工率。一个自然日内，客户给智能助手发消息的会话中，转人工的会话的占比。
statistic_list.statistic.ai_knowledge_hit_rate	float	知识命中率。一个自然日内，客户给智能助手发送的消息中，命中知识库的占比。只有在开启了智能回复原生功能并配置了知识库的情况下，才会产生该项统计数据。当api托管了会话分配，智能回复原生功能失效。若不返回，代表没有向配置知识库的智能接待助手发送消息，该项无法计算
statistic_list.statistic.msg_rejected_customer_cnt	uint64	被拒收消息的客户数。被接待人员设置了“不再接收消息”的客户数