# 获取被动回复概要数据
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getinterfacesummary
本接口用于获取被动回复概要数据
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/datacube/getinterfacesummary?access_token=ACCESS_TOKEN
# 云调用
调用方法:officialAccount.datacube.getInterfaceSummary
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:3
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| begin_date | string | 是 | 2014-12-07 | 起始日期(YYYY-MM-DD格式) |
| end_date | string | 是 | 2014-12-07 | 结束日期(最大时间跨度30天) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| list | object | 数据列表 |
# Res.list Object Payload
数据列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| ref_date | string | 数据的日期 |
| callback_count | number | 通过服务器配置地址获得消息后,被动回复用户消息的次数 |
| fail_count | number | 上述动作的失败次数 |
| total_time_cost | number | 总耗时,除以callback_count即为平均耗时 |
| max_time_cost | number | 最大耗时 |
# 4. 注意事项
- 仅支持查询2014年12月1日之后的数据
- 建议每天上午8点后查询前一天的数据
- 请开发者自行缓存数据降低接口损耗
# 5. 代码示例
请求示例
{
"begin_date": "2014-12-07",
"end_date": "2014-12-07"
}
返回示例
{
"list": [
{
"ref_date": "2014-12-07",
"callback_count": 36974,
"fail_count": 67,
"total_time_cost": 14994291,
"max_time_cost": 5044
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
| 61500 | date format error | 日期格式错误 |
| 61501 | date range error | begin_date和end_date差值超过最大跨度 |
| 61503 | data not ready please try later | 数据尚未生成 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
| 公众号 | 服务号 |
|---|---|
| 仅认证 | 仅认证 |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;