微信卡券 - 微信公众平台 整理笔记

时间:2024-03-04 13:34:58

一、创建卡券


1、步骤一:上传卡券图片素材

https://api.weixin.qq.com/cgi-bin/media/uploadimg?access_token=ACCESS_TOKEN

使用到微信的 CDN

2、步骤二:设置卡券适用门店

location_id_list

3、步骤三:选取卡券背景颜色

color 固定有十四种

4、步骤四:创建卡券

https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

base_info(卡券基础信息)字段 **- **必填字段

base_info(卡券基础信息)字段 - 非必填字段

Advanced_info(卡券高级信息)字段

填入时间限制字段(time_limit,只控制显示,不控制实际使用逻辑,不填默认不显示。

2021-04-06-22-42-17

创建成功后该卡券会自动提交审核,审核结果将通过事件通知商户。开发者可调用设置白名单接口设置用户白名单,领取未通过审核的卡券,测试整个卡券的使用流程。

https://api.weixin.qq.com/card/testwhitelist/set?access_token=TOKEN

1.同时支持“openid”、“username”两种字段设置白名单,总数上限为10个。

2.设置测试白名单接口为全量设置,即测试名单发生变化时需调用该接口重新传入所有测试人员的ID。

(1)厘清概念

卡券分card_idCode码,前者相当于 java 的类,后者相当于 实例化对象。

(2)卡券类型

卡券类型有基本的四种:(还有其他的,如会员卡和电影票等等,见文章后面)

团购券 "card_type": "GROUPON",

代金券 "card_type": "CASH",

折扣券 "card_type": "DISCOUNT",

兑换券 "card_type": "GIFT",

(3)code码类型

use_custom_codeget_custom_code_mode

code码类型有三种:

非自定义code码 (微信后台随机分配 - 默认)

自定义code码

导入code模式

(4)卡券的展示码型

code_type

卡券的展示码型有四种:

二维码/一维码显示code

二维码不显示code

仅code类型

无code类型

(5)卡券详情页支持有三个入口做自定义跳转

使用场景入口

服务场景入口

营销场景入口

跳转外链会自动带参数:http://www.qq.com?encrypt_code=ENCRYPT_CODE&card_id=CARDID

其中 encrypt_code为加密码,需调用解码接口获取真实Code码。

5、快速买单(可自助核销)

二、投放卡券


"outer_str" : "12b"

当用户领取卡券时会将相应设值的outer_id带入领取事件中,推送至开发者服务器。

1、创建二维码接口

https://api.weixin.qq.com/card/qrcode/create?access_token=TOKEN

扫码领一张 or 多张 (最多支持同时领5张)

2H5 线上发券(JS-SDK 接口)

需要获取api_ticket:

https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=wx_card

注意跟JS-SDK 里的 jsapi_ticket 不一样,后者这样获取:https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi

(1)拉取适用卡券列表并获取用户选择信息 chooseCard
(2)批量添加卡券接口 addCard
(3)查看微信卡包中的卡券接口 openCard

3、卡券货架

卡券货架支持开发者通过调用接口生成一个卡券领取H5页面(微信帮你生成),并获取页面链接,进行卡券投放动作。

2021-04-06-22-42-23

4、群发卡券(仅支持非自定义code的卡券)

图文消息群发
根据用户分组群发
根据OpenID列表群发
客服消息下发

三、核销卡券


在用户使用券之后让卡券从用户的微信客户端消失的过程,这个步骤称为核销

1、线下

(1)查询Code接口

https://api.weixin.qq.com/card/code/get?access_token=TOKEN

我们强烈建议开发者在调用核销code接口之前调用查询code接口,并在核销之前对非法状态的code(如转赠中、已删除、已核销等)做出处理。

(2)核销Code接口

https://api.weixin.qq.com/card/code/consume?access_token=TOKEN

此操作不可逆

2、线上

(1)拉取卡券列表接口(JS-SDK

获取到前端用户要核销哪张券,只不过把 code 加密成了encrypt_code

(2)Code解码接口

后台把从前端获取的encrypt_code解码成明文的 code

https://api.weixin.qq.com/card/code/decrypt?access_token=TOKEN

然后接下来的第(3)(4)对应着上面1、线下的(1)(2)两步

四、管理卡券


1、获取用户已领取的卡券

可查所有的,可查某个卡下的:

https://api.weixin.qq.com/card/user/getcardlist?access_token=TOKEN

2、查看卡券详情

查看一张:https://api.weixin.qq.com/card/get?access_token=TOKEN

查看多张: https://api.weixin.qq.com/card/batchget?access_token=TOKEN

3、更改卡券信息

https://api.weixin.qq.com/card/update?access_token=TOKEN

只支持部分字段的更新,详细看文档

有的字段更新后会重新进入审核状态

若开发者置空某些字段,可直接在更新时传“”(空)

4、修改卡券库存

https://api.weixin.qq.com/card/modifystock?access_token=TOKEN

5、更改卡券Code(只针对自定义Code的卡券)

https://api.weixin.qq.com/card/code/update?access_token=TOKEN

为避免用户疑惑,建议仅在发生转赠行为后更改。

6、删除卡券接口

针对 card_id

删除卡券不能删除已被用户领取,保存在微信客户端中的卡券。

https://api.weixin.qq.com/card/delete?access_token=TOKEN

7、设置卡券失效接口

针对 card_id 和 code (都必填)

https://api.weixin.qq.com/card/code/unavailable?access_token=TOKEN

操作不可逆,小心客诉.

8、统计卡券数据

(1)拉取所有卡券概况数据

https://api.weixin.qq.com/datacube/getcardbizuininfo?access_token=ACCESS_TOKEN

范围的话只能拉取非当天之前的数据

(2)获取具体券数据

https://api.weixin.qq.com/datacube/getcardcardinfo?access_token=ACCESS_TOKEN

(3)拉取会员概况数据

https://api.weixin.qq.com/datacube/getcardmembercardinfo?access_token=ACCESS_TOKEN

(4)拉取单张会员卡数据

https://api.weixin.qq.com/datacube/getcardmembercarddetail?access_token=ACCESS_TOKEN

五、卡券事件推送


1、针对卡券

审核事件推送

领取事件推送

转赠事件推送

删除事件推送

核销事件推送

买单事件推送

从卡券进入公众号会话事件推送

库存报警事件(当某个card_id的初始库存数大于200且当前库存小于等于100时,用户尝试领券会触发发送事件给商户,事件每隔12h发送一次。)

2、针对会员卡

会员卡激活事件推送

进入会员卡事件推送

会员卡内容更新事件(如会员卡积分余额发生变动)

3、其他

券点流水详情事件(如当商户朋友的券券点发生变动时)

六、卡券-小程序打通


1、小程序内领取卡券

wx.addcard

2、小程序内查看卡券

wx.opencard

3、卡券内跳转小程序

4、小程序开(会员)卡组件

见下文

六、朋友的券(朋友共享的优惠券)

“一人领取多人共享”

七、立减金


小程序社交立减金是一款帮助商家快速生成具备裂变传播属性的小程序经营工具,用户通过支付、扫码等场景可以参与社交立减金活动,将社交立减金礼包分享至朋友后自己可获取一份,朋友在会话中可随机获取社交立减金,并直达商家小程序使用。

八、特殊票券


1、会议/演出门票

(1)创建会议门票

https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

"card_type": "MEETING_TICKET"

(2)更新会议门票

https://api.weixin.qq.com/card/meetingticket/updateuser?access_token=TOKEN

2、景区门票

(1)创建景区门票

https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

"card_type": "SCENIC_TICKET"

3、电影票

(1)创建电影票

https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

"card_type": "MOVIE_TICKET"

(2)更新电影票

https://api.weixin.qq.com/card/meetingticket/updateuser?access_token=TOKEN

4、飞机票

飞机票与其他卡券相比具有更强的时效性和特殊性,故机票生成后无需经过微信审核,即时生效。

(1)创建飞机票接口

https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

"card_type": "BOARDING_PASS"

(2)更新飞机票信息接口

https://api.weixin.qq.com/card/boardingpass/checkin?access_token=TOKEN

九、会员卡


1、创建会员卡

https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

"card_type": "MEMBER_CARD"

2、激活会员卡

需要用到小程序开(会员)卡组件,分跳转型非跳转型

通过创建会员卡时传的activate_urlauto_activatewx_activate决定。

(1)方法一:自动激活(非跳转型)

"auto_activate": true

(2)方法二:普通一键激活(非跳转型)

步骤一:在创建卡券接口时填入字段

"wx_activate": true

步骤二:设置开卡字段

设置用户激活时需要填写的选项:

https://api.weixin.qq.com/card/membercard/activateuserform/set?access_token=TOKEN

步骤三:接收推送通知

步骤四:调用接口激活会员卡

https://api.weixin.qq.com/card/membercard/activate?access_token=TOKEN

(3)方法三:跳转型一键激活(跳转型)

支持用户在提交会员开卡资料后跳转至商户自定义的网页

步骤一:在创建卡券接口时填入字段

"wx_activate": true,

"wx_activate_after_submit" : true,

"wx_activate_after_submit_url" : "https://qq.com"

步骤二:设置开卡字段

步骤三:获取用户提交资料

微信会在跳转url后拼接获取用户填写信息的参数,或者通过接口拿到:

https://api.weixin.qq.com/card/membercard/activatetempinfo/get?access_token=TOKEN

步骤四:调用接口激活会员卡

https://api.weixin.qq.com/card/membercard/activate?access_token=TOKEN

3、更新会员信息

https://api.weixin.qq.com/card/membercard/updateuser?access_token=TOKEN


参考资料

微信官方文档
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141229