查询活动列表

更新时间：2024.11.18

查询符合条件的多个活动

接口说明

支持商户：【普通服务商】

请求方式：【GET】/v3/marketing/membercard-activity/activities

请求域名：【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

　　　　　【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点，指引点击查看

请求参数

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

query 查询参数

limit 　选填 integer

【最大资源条数】该次请求可返回的最大资源条数

offset 　选填 integer

【请求资源起始位置】该次请求资源的起始位置

card_id 　选填 string(32)

【会员卡ID】商户创建微信会员卡模板成功后系统返回的会员卡ID

activity_type 　必填 string(32)

【活动类型】活动类型：

可选取值

NON_MEMBER_AFTERPAY: 支付后开卡有礼活动（说明：非会员用户在商户侧消费完成后，可曝光在微信支付成功页面的开卡有礼活动）
MEMBER_AFTERPAY: 支付后老会员有礼活动（会员用户在商户侧消费完成后，可曝光在微信支付成功页面的老会员有礼活动）
NON_MEMBER_MINIPROGRAM: 支付前场景开卡有礼活动（说明：覆盖扫码/小程序场景，对于非会员用户，访问开卡组件时可看到开卡有礼活动信息，开卡后获得对应优惠券）
MEMBER_MINIPROGRAM: 支付前场景老会员有礼活动（说明：覆盖扫码/小程序场景，对于会员用户，访问开卡组件时可直接获得活动设置的优惠券）

activity_status 　选填 string(16)

【活动的当前状态】活动的当前状态：

可选取值

CREATED: 已创建，调用创建活动API成功后该活动状态
ONGOING: 运行中，当活动正式开始的时候活动状态
TERMINATED: 已终止，调用终止活动API接口活动状态
OVER_TIME: 已过期，当前活动时间超过结束时间

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/membercard-activity/activities?limit=5&offset=10&card_id=pbLatjvWOibDc5-TBnbUk1pD12o0&activity_type=NON_MEMBER_AFTERPAY&activity_status=CREATED \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json"

应答参数

200 OK

data 　选填 array

【活动详情】活动的详情，包括此资源的所有定义

属性

activity_id 　必填 string(16)

【活动ID】活动的主键，唯一定义此资源的标识

activity_status 　选填 string(16)

【活动的当前状态】活动的当前状态：

可选取值

CREATED: 已创建，调用创建活动API成功后该活动状态
ONGOING: 运行中，当活动正式开始的时候活动状态
TERMINATED: 已终止，调用终止活动API接口活动状态
OVER_TIME: 已过期，当前活动时间超过结束时间

create_time 　选填 string(32)

【创建时间】创建会员卡的时间
遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2020-05-20T13:29:35.120+08:00表示北京时间2020年05月20日13点29分35秒。

update_time 　选填 string(32)

【更新时间】更新时间

遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2020-05-20T13:29:35.120+08:00表示北京时间2020年05月20日13点29分35秒。

card_id 　选填 string(32)

【会员卡ID】商户创建微信会员卡模板成功后系统返回的会员卡ID

activity_name 　必填 string(10)

【活动名称】活动名称，用于内部管理，不对外展示。不超过10个字符

activity_type 　必填 string(32)

【活动类型】活动类型

可选取值

NON_MEMBER_AFTERPAY: 支付后开卡有礼活动（说明：非会员用户在商户侧消费完成后，可曝光在微信支付成功页面的开卡有礼活动）
MEMBER_AFTERPAY: 支付后老会员有礼活动（会员用户在商户侧消费完成后，可曝光在微信支付成功页面的老会员有礼活动）
NON_MEMBER_MINIPROGRAM: 支付前场景开卡有礼活动（说明：覆盖扫码/小程序场景，对于非会员用户，访问开卡组件时可看到开卡有礼活动信息，开卡后获得对应优惠券）
MEMBER_MINIPROGRAM: 支付前场景老会员有礼活动（说明：覆盖扫码/小程序场景，对于会员用户，访问开卡组件时可直接获得活动设置的优惠券）

begin_time 　必填 string(32)

【活动开始时间】活动开始时间，最长可以配置1年内的活动，活动有效期最长90天

end_time 　必填 string(32)

【活动结束时间】活动结束时间，最长可以配置1年内的活动，活动有效期最长90天

award_send_period 　选填 object

【发放时间段】活动时段，可选择活动有效期内部分日期或部分时间段

属性

award_send_time 　选填 array

【有效期内指定部分活动时间段】在整个活动有效期内，指定更小范围的活动时间。
举例：活动整体时间在7月1日-31日，指定具体时间：7月7日、8日；7月17日、18日。

属性

award_send_day_time 　选填 array

【指定时间段】基于“指定日期（award_send_time）”范围内，可再设置每日可用时间，取两者的交集时间段发券。
注意：若想设置指定时间段，则必须同时设置指定日期award_send_time，否则指定时间段的设置不会生效。
举例：活动整体时间在7月1日-31日，指定具体时间：7月7日、8日；7月17日、18日，指定具体时间段：上午9点-下午6点。

属性

stock_list 　必填 array

【优惠券列表】发放的优惠券，一个活动最多支持发放3个批次

属性

out_request_no 　选填 string(64)

【商户请求单号】商户创建活动凭据号（建议格式：商户ID+日期+流水号），商户侧需保持唯一性，主要用于幂等判断，可包含英文字母，数字，｜，_，*，-等内容，不允许出现其他不合法符号

pay_activity_setting 　选填 object

【支付后活动设置】支付后活动的相关配置。当活动类型是NON_MEMBER_AFTERPAY或者MEMBER_AFTERPAY时，必填

属性

logo_url 　必填 string(256)

【商户logo】商户活动logo，会展示在支付结果页。仅支持通过《图片上传API》接口获取的图片URL地址。
1、商户logo大小需为120像素*120像素。
2、支持JPG/JPEG/PNG格式，且图片小于1M。

activity_second_title 　必填 string(9)

【支付结果页活动副标题】支付结果页活动入口的副标题，商家填写的文案会直接展示给用户

mchid_list 　必填 array

【活动曝光商户号】活动曝光商户号。
注意：需要和会员卡归属的品牌号（brand_id）绑定b-m关系

activate_setting 　选填 object

【激活方式设置】设置会员卡激活方式，在活动类型是NON_MEMBER_AFTERPAY时必填

属性

activate_type 　必填 string(16)

【激活类型】自动激活类型，在用户领卡后由微信自动激活；跳转激活类型，用户领卡后，由商家调用api激活

可选取值

AUTO_ACTIVATE: 一键激活；自动激活类型，在用户领卡后由微信自动激活
JUMP_ACTIVATE: 跳转激活；跳转激活类型，用户领卡后，由商家调用API激活

activate_url 　选填 string(256)

【跳转激活的URL】激活类型是跳转激活时，用户点击开卡后跳转到商家网页的URL。如果同时配置了activate_url和activate_miniprogram，则优先跳转到小程序

activate_miniprogram 　选填 object

【跳转激活的小程序】激活类型是跳转激活时，用户点击开卡后跳转到商家小程序。如果同时配置了activate_url和activate_miniprogram，则优先跳转到小程序

属性

payment_setting 　选填 object

【支付设置】可以指定支付模式、支付方式、订单标识等，如果设置了，用户订单需要符合支付设置，才可能曝光

属性

payment_mode 　选填 object

【支付模式】不限制支付模式不填，限制选填

属性

payment_scene_list 　选填 array

【支付场景列表】枚举值：

可选取值

APP: APP支付场景
MICROPAY: 付款码支付
PAP: 委托代扣
MINIPROGRAM: 小程序支付
FACEPAY: 刷脸支付

limit_bank 　选填 string(32)

【指定银行的简称】指定银行的简称，不填则不限制支付银行。银行简称列表详见：银行类型

goods_tags 　选填 string(15)

【订单优惠标记】商户下单时需要传入相同的标记(goods_tag)，用户同时符合其他规则才能享受优惠

miniprogram_activity_setting 　选填 object

【支付前会员活动设置】支付前会员活动设置，当活动类型为：NON_MEMBER_MINIPROGRAM或MEMBER_MINIPROGRAM时，可选填

属性

offset 　选填 integer

【请求资源起始位置】该次请求资源的起始位置，同请求的

limit 　选填 integer

【最大资源条数】该次请求可返回的最大资源条数

total_count 　选填 integer

【资源总条数】可选返回，资源总条数。当offset=0或者当前查询为空时应该返回总条数。如果系统性能允许时，建议返回。

应答示例

200 OK

1{
2  "data": [{
3    "activity_id": "371067",
4    "activity_status": "ONGOING",
5    "create_time": "2015-05-20T13:29:35.120+08:00",
6    "update_time": "2015-05-20T13:29:35.120+08:00",
7    "card_id": "pbLatjvWOibDc5-TBnbUk1pD12o0",
8    "activity_name": "良品铺子回馈活动",
9    "activity_type": "NON_MEMBER_AFTERPAY",
10    "begin_time": "2020-01-20T13:29:35.120+08:00",
11    "end_time": "2020-01-29T13:29:35.120+08:00",
12    "award_send_period": {
13      "award_send_time": [{
14        "begin_time": "2020-01-21T00:00:00.000+08:00",
15        "end_time": "2020-01-27T00:00:00.000+08:00"
16      }],
17      "award_send_day_time": [{
18        "begin_day_time": {
19          "hours": 9,
20          "minutes": 34,
21          "seconds": 6
22        },
23        "end_day_time": {
24          "hours": 9,
25          "minutes": 34,
26          "seconds": 6
27        }
28      }]
29    },
30    "stock_list": [{
31      "stock_creator_mchid": "10000022",
32      "stock_id": "98065001"
33    }],
34    "out_request_no": "100002322019090134234sfdf",
35    "pay_activity_setting": {
36      "logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
37      "activity_second_title": "湖南麻辣美食券",
38      "mchid_list": [
39        "10000022",
40        "10000023"
41      ],
42      "activate_setting": {
43        "activate_type": "AUTO_ACTIVATE",
44        "activate_url": "https://w.url.cn/s/Ahz3p2C",
45        "activate_miniprogram": {
46          "activate_appid": "wxea9c30a90fs8d3fe",
47          "activate_path": "pages/activate/activate"
48        }
49      },
50      "payment_setting": {
51        "payment_mode": {
52          "payment_scene_list": [
53            "APP"
54          ]
55        },
56        "limit_bank": "CFT",
57        "goods_tags": [
58          "xxx",
59          "yyy"
60        ]
61      },
62      "miniprogram_activity_setting": {
63        "outer_str": [
64          "领取渠道1",
65          "领取渠道2"
66        ],
67        "award_jump_deploy": {
68          "mini_program_appid": "wxc0b84a53ed8e8d29",
69          "mini_program_path": "mall/pages/List",
70          "button_text": "点击"
71        }
72      }
73    }
74  }],
75  "offset": 10,
76  "limit": 5,
77  "total_count": 1234
78}

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅接口规则
401	SIGN_ERROR	验证不通过	请参阅签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
403	NO_AUTH	商户暂无权限使用此功能	请开通商户号权限。请联系产品或商务申请
400	INVALID_REQUEST	活动创建方未被授权发放此商家券批次	请先调用API授权活动创建方发放当前商家券批次
400	INVALID_REQUEST	活动曝光商户号需要绑定到会员卡品牌	请先将活动商户号绑定到品牌
400	INVALID_REQUEST	活动创建方需要和会员卡归属品牌号绑定	请先将活动创建方商户号绑定到品牌
400	INVALID_REQUEST	请先升级会员卡才能使用此功能	请先调用《升级会员卡API》升级会员卡
400	INVALID_REQUEST	当前会员卡是实时传入code模式，不支持	请更换非实时code模式的会员卡再重试

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服