微信公众平台的开发者文档
微信公众平台的开发者文档
  1. 使用微信公众平台开发前必读
    1. 微信公众平台开发概述
    2. 微信公众平台开发者规范
    3. 微信公众号接口权限说明
    4. 微信公众号接口调用频次限制说明
  2. 开始开发微信公众平台
    1. 微信开发者平台接入指南
    2. 微信公众平台接口域名说明
    3. 微信平台开发者获取access_token
    4. 获取微信服务器IP地址
    5. 微信平台开发报警排查指引
    6. 微信接口测试号申请
  3. 微信公众平台自定义开发
    1. 微信平台开发自定义菜单创建接口
    2. 微信公众平台自定义菜单查询接口
    3. 微信自定义菜单删除接口
    4. 微信自定义菜单事件推送
    5. 微信公众平台个性化菜单接口
    6. 微信获取自定义菜单配置接口
  4. 微信公众平台 消息管理
    1. 微信平台接收普通消息
    2. 微信平台开发接收事件推送
    3. 微信平台被动回复用户消息
    4. 微信消息加解密说明
    5. 微信公众号客服消息
    6. 微信高级群发接口
    7. 微信公众号开发模板消息接口
    8. 微信平台开发者模板消息运营规范
    9. 获取微信公众号的自动回复规则
  5. 微信网页开发
    1. 微信网页授权
    2. 微信网页开发样式库
    3. 微信JS-SDK说明文档
    4. 微信web开发者工具
  6. 微信平台素材管理
    1. 微信新增临时素材
    2. 获取微信平台临时素材
    3. 微信开发者新增永久素材
    4. 微信开发者 删除永久素材
    5. 微信开发者修改永久图文素材
    6. 获取微信公众号素材总数
    7. 获取微信公众平台的素材列表
  7. 微信平台 用户管理
    1. 微信公众号用户标签管理
    2. 微信平台开发者设置用户备注名
    3. 获取微信公众号用户的基本信息(UnionID机制)
    4. 获取微信公众号用户列表
    5. 获取微信用户地理位置
    6. 微信公众号黑名单管理
  8. 管理微信账号
    1. 微信生成带参数的二维码
    2. 微信公众号长链接转短链接接口
    3. 微信认证事件推送
  9. 微信公众号数据统计
    1. 微信用户分析数据接口
    2. 微信图文分析数据接口
    3. 微信消息分析数据接口
    4. 微信接口分析数据接口
  10. 微信卡券接口说明
    1. 微信卡券接口
    2. 微信平台开发者创建卡券
    3. 微信平台投放卡券
    4. 核销微信平台的卡券
    5. 微信公众号管理卡券
    6. 微信卡券事件推送
    7. 微信平台会员卡专区（一）
    8. 微信平台会员卡专区（二）
    9. 微信优惠券朋友的券专区
    10. 微信特殊票券
    11. 第三方微信开发者模式
    12. 微信卡券错误码
  11. 微信门店
    1. 微信门店接口
  12. 微信小店
    1. 微信小店接口
    2. 微信平台语义理解接口
  13. 微信设备功能
    1. 微信服务号设备功能介绍
    2. 微信如何新增产品型号
  14. 微信平台新版客服功能
    1. 将消息转发到微信客服
    2. 微信客服管理
    3. 微信会话控制
    4. 微信获取聊天记录
  15. 微信摇一摇周边
    1. 申请开通微信摇一摇
    2. 微信设备ID
    3. 微信摇一摇页面管理
    4. 微信摇一摇上传图片素材
    5. 微信平台管理设备与页面的关联关系
    6. 微信摇一摇数据统计
    7. 微信摇一摇关注的JSAPI
    8. 微信摇一摇事件通知
    9. 微信html5页面获取设备信息
    10. 微信摇一摇获取设备及用户信息
    11. 微信摇一摇红包介绍说明
    12. 微信摇一摇周边错误码
  16. 微信连WIFI
    1. 微信连Wi-Fi开发者指引
    2. 微信Wi-Fi硬件鉴权协议接口说明
    3. 微信Wi-Fi软件服务管理接口说明
    4. 开通微信连Wi-Fi插件
    5. 微信Wi-Fi门店管理
    6. 微信Wi-Fi设备管理
    7. 配置微信WiFi联网方式
    8. 微信商家主页管理
    9. 微信平台Wi-Fi数据统计
    10. 连网后微信公众号下发消息
    11. 微信卡券投放
    12. 微信Wi-Fi接口返回错误码
    13. 微信连网过程常见错误码
  17. 微信扫一扫
    1. 微信扫一扫接入指南
    2. 微信上进行商品创建
    3. 微信商品发布
    4. 微信商品管理
    5. 微信扫一扫事件推送
    6. 微信一物一码专区
    7. 微信扫一扫错误码
    8. 微信公众号在线帮助工具
    9. 微信扫一扫常见问题
阅读(18.4k) 书签 赞(0) 我要纠错

微信卡券事件推送

2019-03-14 15:34 更新

卡券事件推送

卡券事件推送

1.更新日志

版本号更新内容更新时间
V1.0核销事件新增核销门店，如果为手机助手核销则可以推送核销员openid。2015-8-31
V1.1核销事件新增买单相关字段，商户订单号和微信支付交易订单号。2015-9-8
V1.2新增库存报警事件，当用户领取到最好一张卡券的时候推送库存报警事件2015-9-8
V1.3新增库会员卡内容更新事件，通过事件告知开发者积分和余额变动情况2015-10-28
V1.4新增转赠会员卡接口2016-9-19

2.卡券事件推送

卡券通过审核、卡券被用户领取、卡券被用户删除、卡券被商户核销、从卡券进入公众号等情况均会触发事件推送，该事件将发送至开发者填写的URL（登录公众平台进入【开发者中心设置】）。 开发者可通过事件推送完成数据统计、用户身份识别等操作。

微信服务器在五秒内收不到响应会断掉连接，并且重新发起请求，总共重试三次。关于重试的消息排重，推荐使用FromUserName + CreateTime 排重。假如服务器无法保证在五秒内处理并回复，可以直接回复空串，微信服务器不会对此作任何处理，并且不会发起重试。

2.1 审核事件推送

生成的卡券通过审核时，微信会把这个事件推送到开发者填写的URL。

<xml> 
  <ToUserName><![CDATA[toUser]]></ToUserName>  
  <FromUserName><![CDATA[FromUser]]></FromUserName>  
  <CreateTime>123456789</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[card_pass_check]]></Event> //不通过为card_not_pass_check 
  <CardId><![CDATA[cardid]]></CardId>  
  <RefuseReason><![CDATA[非法代制]]></RefuseReason> 
</xml>

参数说明：

参数说明
ToUserName开发者微信号
FromUserName发送方帐号（一个OpenID）
CreateTime消息创建时间 （整型）
MsgType消息类型，event
Event事件类型，card_pass_check(卡券通过审核)、card_not_pass_check（卡券未通过审核）
CardId卡券ID

RefuseReason

审核不通过原因

使用网页调试工具调试该接口

2.2 领取事件推送

用户在领取卡券时，微信会把这个事件推送到开发者填写的URL。 推送XML数据包示例：

<xml> 
  <ToUserName> <![CDATA[gh_fc0a06a20993]]> </ToUserName>  
  <FromUserName> <![CDATA[oZI8Fj040-be6rlDohc6gkoPOQTQ]]> </FromUserName>  
  <CreateTime>1472551036</CreateTime>  
  <MsgType> <![CDATA[event]]> </MsgType>  
  <Event> <![CDATA[user_get_card]]> </Event>  
  <CardId> <![CDATA[pZI8Fjwsy5fVPRBeD78J4RmqVvBc]]> </CardId>  
  <IsGiveByFriend>0</IsGiveByFriend>  
  <UserCardCode> <![CDATA[226009850808]]> </UserCardCode>  
  <FriendUserName> <![CDATA[]]> </FriendUserName>  
  <OuterId>0</OuterId>  
  <OldUserCardCode> <![CDATA[]]> </OldUserCardCode>  
  <OuterStr> <![CDATA[12b]]> </OuterStr>  
  <IsRestoreMemberCard>0</IsRestoreMemberCard>  
  <IsRecommendByFriend>0</IsRecommendByFriend> 
</xml>

参数说明：

参数说明
ToUserName开发者微信号。
FromUserName领券方帐号（一个OpenID）。
CreateTime消息创建时间 （整型）。
MsgType消息类型，event
Event事件类型，user_get_card(用户领取卡券)。
CardId卡券ID。
IsGiveByFriend是否为转赠领取，1代表是，0代表否。
FriendUserName当IsGiveByFriend为1时填入的字段，表示发起转赠用户的openid
UserCardCodecode序列号。
OldUserCardCode为保证安全，微信会在转赠发生后变更该卡券的code号，该字段表示转赠前的code。
OuterStr
领取场景值，用于领取渠道数据统计。可在生成二维码接口及添加Addcard接口中自定义该字段的字符串值。
IsRestoreMemberCard用户删除会员卡后可重新找回，当用户本次操作为找回时，该值为1，否则为0

使用网页调试工具调试该接口


2.3转赠事件推送

用户在转赠卡券时，微信会把这个事件推送到开发者填写的URL。 推送XML数据包示例：


<xml>
  <ToUserName><![CDATA[gh_3fcea188bf78]]></ToUserName>  
  <FromUserName><![CDATA[obLatjjwDolFjRRd3doGIdwNqRXw]]></FromUserName>  
  <CreateTime>1474181868</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[user_gifting_card]]></Event>  
  <CardId><![CDATA[pbLatjhU-3pik3d4PsbVzvBxZvJc]]></CardId>  
  <UserCardCode><![CDATA[297466945104]]></UserCardCode>  
  <IsReturnBack>0</IsReturnBack>  
  <FriendUserName><![CDATA[obLatjlNerkb62HtSdQUx66C4NTU]]></FriendUserName>  
  <IsChatRoom>0</IsChatRoom> 
</xml>

参数说明：

参数说明
ToUserName开发者微信号。
FromUserName领券方帐号（一个OpenID）。
CreateTime消息创建时间 （整型）。
MsgType消息类型，event
Event事件类型，user_gifting_card(用户转赠卡券)。
CardId卡券ID。
FriendUserName接收卡券用户的openid
UserCardCodecode序列号。

IsReturnBack

是否转赠退回，0代表不是，1代表是。

IsChatRoom

是否是群转赠

使用网页调试工具调试该接口

2.4 删除事件推送

用户在删除卡券时，微信会把这个事件推送到开发者填写的URL。 推送XML数据包示例：

<xml> <ToUserName><![CDATA[toUser]]></ToUserName> 
<FromUserName><![CDATA[FromUser]]></FromUserName> 
<CreateTime>123456789</CreateTime> 
<MsgType><![CDATA[event]]></MsgType> 
<Event><![CDATA[user_del_card]]></Event> 
<CardId><![CDATA[cardid]]></CardId> 
<UserCardCode><![CDATA[12312312]]></UserCardCode>
</xml>

参数说明：

参数说明
ToUserName开发者微信号。
FromUserName发送方帐号（一个OpenID）
CreateTime消息创建时间 （整型）。
MsgType消息类型，event
Event事件类型，user_del_card(用户删除卡券)
CardId卡券ID。
UserCardCodecode序列号。自定义code及非自定义code的卡券被领取后都支持事件推送。

使用网页调试工具调试该接口

2.5 核销事件推送

卡券被核销时，微信会把这个事件推送到开发者填写的URL。 推送XML数据包示例：

<xml> 
  <ToUserName> <![CDATA[gh_fc0a06a20993]]> </ToUserName>  
  <FromUserName> <![CDATA[oZI8Fj040-be6rlDohc6gkoPOQTQ]]> </FromUserName>  
  <CreateTime>1472549042</CreateTime>  
  <MsgType> <![CDATA[event]]> </MsgType>  
  <Event> <![CDATA[user_consume_card]]> </Event>  
  <CardId> <![CDATA[pZI8Fj8y-E8hpvho2d1ZvpGwQBvA]]> </CardId>  
  <UserCardCode> <![CDATA[452998530302]]> </UserCardCode>  
  <ConsumeSource> <![CDATA[FROM_API]]> </ConsumeSource>  
  <LocationName> <![CDATA[]]> </LocationName>  
  <StaffOpenId> <![CDATA[oZ********nJ3bPJu_Rtjkw4c]]> </StaffOpenId>  
  <VerifyCode> <![CDATA[]]> </VerifyCode>  
  <RemarkAmount> <![CDATA[]]> </RemarkAmount>  
  <OuterStr> <![CDATA[xxxxx]]> </OuterStr> 
</xml>
参数说明
ToUserName开发者微信号。
FromUserName发送方帐号（一个OpenID）。
CreateTime消息创建时间 （整型）。
MsgType消息类型，event。
Event事件类型，user_consume_card(核销事件)
CardId卡券ID。
UserCardCode卡券Code码。
ConsumeSource核销来源。支持开发者统计API核销（FROM_API）、公众平台核销（FROM_MP）、卡券商户助手核销（FROM_MOBILE_HELPER）（核销员微信号）
LocationName门店名称，当前卡券核销的门店名称（只有通过自助核销和买单核销时才会出现该字段）
StaffOpenId核销该卡券核销员的openid（只有通过卡券商户助手核销时才会出现）

VerifyCode

自助核销时，用户输入的验证码

RemarkAmount自助核销时，用户输入的备注金额
OuterStr开发者发起核销时传入的自定义参数，用于进行核销渠道统计

使用网页调试工具调试该接口

2.6 买单事件推送

微信买单完成时，微信会把这个事件推送到开发者填写的URL。 推送XML数据包示例：

<xml> 
  <ToUserName><![CDATA[gh_e2243xxxxxxx]]></ToUserName>  
  <FromUserName><![CDATA[oo2VNuOUuZGMxxxxxxxx]]></FromUserName>  
  <CreateTime>1442390947</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[user_pay_from_pay_cell]]></Event>  
  <CardId><![CDATA[po2VNuCuRo-8sxxxxxxxxxxx]]></CardId>  
  <UserCardCode><![CDATA[38050000000]]></UserCardCode>  
  <TransId><![CDATA[10022403432015000000000]]></TransId>  
  <LocationId>291710000</LocationId>  
  <Fee><![CDATA[10000]]></Fee>  
  <OriginalFee><![CDATA[10000]]> </OriginalFee> 
</xml>
参数说明
ToUserName开发者微信号。
FromUserName发送方帐号（一个OpenID）。
CreateTime消息创建时间 （整型）。
MsgType消息类型，event。
Event事件类型，User_pay_from_pay_cell(微信买单事件)
CardId卡券ID。
UserCardCode卡券Code码。
TransId微信支付交易订单号（只有使用买单功能核销的卡券才会出现）
LocationId门店ID，当前卡券核销的门店ID（只有通过卡券商户助手和买单核销时才会出现）
Fee实付金额，单位为分
OriginalFee应付金额，单位为分

使用网页调试工具调试该接口

2.7 进入会员卡事件推送

用户在进入会员卡时，微信会把这个事件推送到开发者填写的URL。

需要开发者在创建会员卡时填入need_push_on_view 字段并设置为true。开发者须综合考虑领卡人数和服务器压力，决定是否接收该事件。

推送XML数据包示例：

<xml> 
  <ToUserName> <![CDATA[gh_fcxxxx6a20993]]> </ToUserName>  
  <FromUserName> <![CDATA[oZI8Fj040-xxxxx6gkoPOQTQ]]> </FromUserName>  
  <CreateTime>1467811138</CreateTime>  
  <MsgType> <![CDATA[event]]> </MsgType>  
  <Event> <![CDATA[user_view_card]]> </Event>  
  <CardId> <![CDATA[pZI8Fj2ezBbxxxxxT2UbiiWLb7Bg]]> </CardId>  
  <UserCardCode> <![CDATA[4xxxxxxxx8558]]> </UserCardCode>  
  <OuterStr> <![CDATA[12b]]> </OuterStr> 
</xml>

参数说明：

参数说明
ToUserName开发者微信号。
FromUserName发送方帐号（一个OpenID）。
CreateTime消息创建时间 （整型）。
MsgType消息类型，event。
Event事件类型，user_view_card(用户点击会员卡)
CardId卡券ID。
UserCardCode商户自定义code值。非自定code推送为空串。
OuterStr商户自定义二维码渠道参数，用于标识本次扫码打开会员卡来源来自于某个渠道值的二维码

使用网页调试工具调试该接口


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

用户在卡券里点击查看公众号进入会话时（需要用户已经关注公众号），微信会把这个事件推送到开发者填写的URL。开发者可识别从卡券进入公众号的用户身份。 推送XML数据包示例：

<xml> 
  <ToUserName><![CDATA[toUser]]></ToUserName>  
  <FromUserName><![CDATA[FromUser]]></FromUserName>  
  <CreateTime>123456789</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[user_enter_session_from_card]]></Event>  
  <CardId><![CDATA[cardid]]></CardId>  
  <UserCardCode><![CDATA[12312312]]></UserCardCode> 
</xml>

参数说明：

参数说明
ToUserName开发者微信号。
FromUserName发送方帐号（一个OpenID）
CreateTime消息创建时间 （整型）。
MsgType消息类型，event
Event事件类型，user_enter_session_from_card(用户从卡券进入公众号会话)
CardId卡券ID。
UserCardCodeCode码。

使用网页调试工具调试该接口


2.9 会员卡内容更新事件

当用户的会员卡积分余额发生变动时，微信会推送事件告知开发者。 推送XML数据包示例：

<xml>
  <ToUserName><![CDATA[gh_9e1765b5568e]]></ToUserName>  
  <FromUserName><![CDATA[ojZ8YtyVyr30HheH3CM73y7h4jJE]]></FromUserName>  
  <CreateTime>1445507140</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[update_member_card]]></Event>  
  <CardId><![CDATA[pjZ8Ytx-nwvpCRyQneH3Ncmh6N94]]></CardId>  
  <UserCardCode><![CDATA[485027611252]]></UserCardCode>  
  <ModifyBonus>3</ModifyBonus>  
  <ModifyBalance>0</ModifyBalance> 
</xml>


参数说明：

参数说明
ToUserName开发者微信号。
FromUserName发送方帐号（一个OpenID）
CreateTime消息创建时间 （整型）。
MsgType消息类型，event
Event事件类型，update_member_card(会员卡内容更新）
CardId卡券ID。
UserCardCodeCode码。
ModifyBonus变动的积分值。
ModifyBalance变动的余额值。

使用网页调试工具调试该接口

2.10 库存报警事件

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

<xml> 
  <ToUserName><![CDATA[gh_2d62d*****0]]></ToUserName>  
  <FromUserName><![CDATA[oa3LFuBvWb7*********]]></FromUserName>  
  <CreateTime>1443838506</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[card_sku_remind]]></Event>  
  <CardId><![CDATA[pa3LFuAh2P65**********]]></CardId>  
  <Detail><![CDATA[the card's quantity is equal to 0]]></Detail> 
</xml>

参数说明：

参数说明
ToUserName开发者微信号
FromUserName发送方，微信
CreateTime消息创建时间 （整型）
MsgType消息类型，event
Event事件类型，card_sku_remind库存报警
CardId卡券ID
Detail报警详细信息

使用网页调试工具调试该接口

2.11 券点流水详情事件

当商户朋友的券券点发生变动时，微信服务器会推送消息给商户服务器。

<xml> 
  <ToUserName><![CDATA[gh_7223c83d4be5]]></ToUserName>  
  <FromUserName><![CDATA[ob5E7s-HoN9tslQY3-0I4qmgluHk]]></FromUserName>  
  <CreateTime>1453295737</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[card_pay_order]]></Event>  
  <OrderId><![CDATA[404091456]]></OrderId>  
  <Status><![CDATA[ORDER_STATUS_FINANCE_SUCC]]></Status>  
  <CreateOrderTime>1453295737</CreateOrderTime>  
  <PayFinishTime>0</PayFinishTime>  
  <Desc><![CDATA[]]></Desc>  
  <FreeCoinCount><![CDATA[200]]></FreeCoinCount>  
  <PayCoinCount><![CDATA[0]]></PayCoinCount>  
  <RefundFreeCoinCount><![CDATA[0]]></RefundFreeCoinCount>  
  <RefundPayCoinCount><![CDATA[0]]></RefundPayCoinCount>  
  <OrderType><![CDATA[ORDER_TYPE_SYS_ADD]]></OrderType>  
  <Memo><![CDATA[开通账户奖励]]></Memo>  
  <ReceiptInfo><![CDATA[]]></ReceiptInfo> 
</xml>

参数说明：

参数说明
ToUserName开发者微信号
FromUserName发送方，微信
CreateTime消息创建时间 （整型）
MsgType消息类型，event
Event事件类型，card_pay_order券点流水详情事件
OrderId本次推送对应的订单号
Status本次订单号的状态,ORDER_STATUS_WAITING 等待支付 ORDER_STATUS_SUCC 支付成功 ORDER_STATUS_FINANCE_SUCC 加代币成功 ORDER_STATUS_QUANTITY_SUCC 加库存成功 ORDER_STATUS_HAS_REFUND 已退币 ORDER_STATUS_REFUND_WAITING 等待退币确认 ORDER_STATUS_ROLLBACK 已回退,系统失败 ORDER_STATUS_HAS_RECEIPT 已开发票
CreateOrderTime购买券点时，支付二维码的生成时间
PayFinishTime购买券点时，实际支付成功的时间
Desc支付方式，一般为微信支付充值
FreeCoinCount剩余免费券点数量
PayCoinCount剩余付费券点数量
RefundFreeCoinCount本次变动的免费券点数量
RefundPayCoinCount本次变动的付费券点数量
OrderType所要拉取的订单类型

ORDER_TYPE_SYS_ADD 平台赠送券点 ORDER_TYPE_WXPAY 充值券点 ORDER_TYPE_REFUND 库存未使用回退券点 ORDER_TYPE_REDUCE 券点兑换库存 ORDER_TYPE_SYS_REDUCE 平台扣减

Memo系统备注，说明此次变动的缘由，如开通账户奖励、门店奖励、核销奖励以及充值、扣减。
ReceiptInfo所开发票的详情

使用网页调试工具调试该接口

 2.12 会员卡激活事件推送

当用户通过一键激活的方式提交信息并点击激活时，商户会收到用户激活的事件推送

<xml> 
  <ToUserName> <![CDATA[gh_3fcea188bf78]]></ToUserName>  
  <FromUserName><![CDATA[obLatjlaNQKb8FqOvt1M1x1lIBFE]]></FromUserName>  
  <CreateTime>1432668700</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[submit_membercard_user_info]]></Event>  
  <CardId><![CDATA[pbLatjtZ7v1BG_ZnTjbW85GYc_E8]]></CardId>  
  <UserCardCode><![CDATA[018255396048]]></UserCardCode> 
</xml>


参数说明

参数            说明            
ToUserName            开发者微信号            
FromUserName            发送方帐号（一个OpenID）            
CreateTime            消息创建时间 （整型）            
MsgType            消息类型，event            
CardId            卡券ID            
UserCardCode            卡券Code码            

使用网页调试工具调试该接口



以上内容是否对您有帮助：
← 微信公众号管理卡券
微信平台会员卡专区（一） →
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号