# 查询小店礼物活动列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:list_present_activity
通过该接口查询小店授权送礼活动列表。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/b2c/activity/list/promoter/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| offset | number | 是 | 偏移量 |
| limit | number | 是 | 单次请求个数,最大为100 |
| shop_appid | string | 否 | 小店appid |
| status | number | 否 | 活动状态:1 未开始,2 进行中,4 已开奖,5 失效 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| list | objarray | 信息列表 |
| total_num | number | 总数 |
# Res.list(Array) Object Payload
信息列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| shop_appid | string | 小店appid |
| shop_nickname | string | 小店昵称 |
| activity_id | number | 小店活动id |
| status | number | 活动状态 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"offset": 0,
"limit": 100
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"list": [
{
"shop_appid": "wxxxxxxxxxxxxxxxxx",
"shop_nickname": "小店昵称",
"activity_id": "111"
},
{
"shop_appid": "wxxxxxxxxxxxxxxxxx",
"shop_nickname": "小店昵称",
"activity_id": "222"
}
],
"total_num": 2
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 40097 | 参数错误 |
| 10020002 | 非法的limit参数,应该小于等于100 |
| 10028004 | 推广者账号送礼被封禁 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
| 小程序 | 小游戏 | 微信小店 |
|---|---|---|
| ✔ | ✔ | ✔ |
- ✔:该账号可调用此接口。
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口。