# 获取消息发送周数据
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getupstreammsgweek
本接口用于获取消息发送周数据
每个周的周期数据的数据标注日期在当周的第一天(当月1日或周一)。在某一周过后去调用接口,才能获取到该周期的数据。比如,在12月1日以(11月1日-11月5日)作为(begin_date和end_date)调用获取月数据接口,可以获取到11月1日的月数据(即11月的月数据)。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/datacube/getupstreammsgweek?access_token=ACCESS_TOKEN
# 云调用
调用方法:officialAccount.datacube.getUpstreamMsgWeek
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:1
服务商获得其中之一权限集授权后,可通过使用 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 | 结束日期(必须为同一天) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
list | objarray | 数据列表 |
# Res.list(Array) Object Payload
数据列表
参数名 | 类型 | 说明 |
---|---|---|
ref_date | string | 数据的日期,需在begin_date和end_date之间 |
msg_type | number | 消息类型,代表含义如下: 1代表文字 2代表图片 3代表语音 4代表视频 6代表第三方应用消息(链接消息) |
msg_user | number | 上行发送了(向公众号发送了)消息的用户数 |
msg_count | number | 上行发送了消息的消息总数 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"begin_date": "2014-12-07",
"end_date": "2014-12-08"
}
返回示例
{
"list": [
{
"ref_date": "2014-12-07",
"msg_type": 1,
"msg_user": 282,
"msg_count": 817
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
公众号 | 服务号 |
---|---|
仅认证 | 仅认证 |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;