閱讀(18.5k) 書簽贊(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	新增庫會員卡內容更新事件，通過事件告知開發(fā)者積分和余額變動情況	2015-10-28
V1.4	新增轉贈會員卡接口	2016-9-19

2.卡券事件推送

卡券通過審核、卡券被用戶領取、卡券被用戶刪除、卡券被商戶核銷、從卡券進入公眾號等情況均會觸發(fā)事件推送，該事件將發(fā)送至開發(fā)者填寫的URL（登錄公眾平臺進入【開發(fā)者中心設置】）。開發(fā)者可通過事件推送完成數(shù)據(jù)統(tǒng)計、用戶身份識別等操作。

微信服務器在五秒內收不到響應會斷掉連接，并且重新發(fā)起請求，總共重試三次。關于重試的消息排重，推薦使用FromUserName + CreateTime 排重。假如服務器無法保證在五秒內處理并回復，可以直接回復空串，微信服務器不會對此作任何處理，并且不會發(fā)起重試。

2.1 審核事件推送

生成的卡券通過審核時，微信會把這個事件推送到開發(fā)者填寫的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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號
FromUserName	發(fā)送方帳號（一個OpenID）
CreateTime	消息創(chuàng)建時間（整型）
MsgType	消息類型，event
Event	事件類型，card_pass_check(卡券通過審核)、card_not_pass_check（卡券未通過審核）
CardId	卡券ID
RefuseReason	審核不通過原因

使用網頁調試工具調試該接口

2.2 領取事件推送

用戶在領取卡券時，微信會把這個事件推送到開發(fā)者填寫的URL。推送XML數(shù)據(jù)包示例：

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	領券方帳號（一個OpenID）。
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event
Event	事件類型，user_get_card(用戶領取卡券)。
CardId	卡券ID。
IsGiveByFriend	是否為轉贈領取，1代表是，0代表否。
FriendUserName	當IsGiveByFriend為1時填入的字段，表示發(fā)起轉贈用戶的openid
UserCardCode	code序列號。
OldUserCardCode	為保證安全，微信會在轉贈發(fā)生后變更該卡券的code號，該字段表示轉贈前的code。
OuterStr	領取場景值，用于領取渠道數(shù)據(jù)統(tǒng)計?？稍谏啥S碼接口及添加Addcard接口中自定義該字段的字符串值。
IsRestoreMemberCard	用戶刪除會員卡后可重新找回，當用戶本次操作為找回時，該值為1，否則為0

使用網頁調試工具調試該接口

2.3轉贈事件推送

用戶在轉贈卡券時，微信會把這個事件推送到開發(fā)者填寫的URL。推送XML數(shù)據(jù)包示例：

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	領券方帳號（一個OpenID）。
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event
Event	事件類型，user_gifting_card(用戶轉贈卡券)。
CardId	卡券ID。
FriendUserName	接收卡券用戶的openid
UserCardCode	code序列號。
IsReturnBack	是否轉贈退回，0代表不是，1代表是。
IsChatRoom	是否是群轉贈

使用網頁調試工具調試該接口

2.4 刪除事件推送

用戶在刪除卡券時，微信會把這個事件推送到開發(fā)者填寫的URL。推送XML數(shù)據(jù)包示例：

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	發(fā)送方帳號（一個OpenID）
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event
Event	事件類型，user_del_card(用戶刪除卡券)
CardId	卡券ID。
UserCardCode	code序列號。自定義code及非自定義code的卡券被領取后都支持事件推送。

使用網頁調試工具調試該接口

2.5 核銷事件推送

卡券被核銷時，微信會把這個事件推送到開發(fā)者填寫的URL。推送XML數(shù)據(jù)包示例：

<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>

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	發(fā)送方帳號（一個OpenID）。
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event。
Event	事件類型，user_consume_card(核銷事件)
CardId	卡券ID。
UserCardCode	卡券Code碼。
ConsumeSource	核銷來源。支持開發(fā)者統(tǒng)計API核銷（FROM_API）、公眾平臺核銷（FROM_MP）、卡券商戶助手核銷（FROM_MOBILE_HELPER）（核銷員微信號）
LocationName	門店名稱，當前卡券核銷的門店名稱（只有通過自助核銷和買單核銷時才會出現(xiàn)該字段）
StaffOpenId	核銷該卡券核銷員的openid（只有通過卡券商戶助手核銷時才會出現(xiàn)）
VerifyCode	自助核銷時，用戶輸入的驗證碼
RemarkAmount	自助核銷時，用戶輸入的備注金額
OuterStr	開發(fā)者發(fā)起核銷時傳入的自定義參數(shù)，用于進行核銷渠道統(tǒng)計

使用網頁調試工具調試該接口

2.6 買單事件推送

微信買單完成時，微信會把這個事件推送到開發(fā)者填寫的URL。推送XML數(shù)據(jù)包示例：

<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>

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	發(fā)送方帳號（一個OpenID）。
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event。
Event	事件類型，User_pay_from_pay_cell(微信買單事件)
CardId	卡券ID。
UserCardCode	卡券Code碼。
TransId	微信支付交易訂單號（只有使用買單功能核銷的卡券才會出現(xiàn)）
LocationId	門店ID，當前卡券核銷的門店ID（只有通過卡券商戶助手和買單核銷時才會出現(xiàn)）
Fee	實付金額，單位為分
OriginalFee	應付金額，單位為分

使用網頁調試工具調試該接口

2.7 進入會員卡事件推送

用戶在進入會員卡時，微信會把這個事件推送到開發(fā)者填寫的URL。

需要開發(fā)者在創(chuàng)建會員卡時填入need_push_on_view 字段并設置為true。開發(fā)者須綜合考慮領卡人數(shù)和服務器壓力，決定是否接收該事件。

推送XML數(shù)據(jù)包示例：

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	發(fā)送方帳號（一個OpenID）。
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event。
Event	事件類型，user_view_card(用戶點擊會員卡)
CardId	卡券ID。
UserCardCode	商戶自定義code值。非自定code推送為空串。
OuterStr	商戶自定義二維碼渠道參數(shù)，用于標識本次掃碼打開會員卡來源來自于某個渠道值的二維碼

使用網頁調試工具調試該接口

2.8 從卡券進入公眾號會話事件推送

用戶在卡券里點擊查看公眾號進入會話時（需要用戶已經關注公眾號），微信會把這個事件推送到開發(fā)者填寫的URL。開發(fā)者可識別從卡券進入公眾號的用戶身份。推送XML數(shù)據(jù)包示例：

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	發(fā)送方帳號（一個OpenID）
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event
Event	事件類型，user_enter_session_from_card(用戶從卡券進入公眾號會話)
CardId	卡券ID。
UserCardCode	Code碼。

使用網頁調試工具調試該接口

2.9 會員卡內容更新事件

當用戶的會員卡積分余額發(fā)生變動時，微信會推送事件告知開發(fā)者。推送XML數(shù)據(jù)包示例：

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號。
FromUserName	發(fā)送方帳號（一個OpenID）
CreateTime	消息創(chuàng)建時間（整型）。
MsgType	消息類型，event
Event	事件類型，update_member_card(會員卡內容更新）
CardId	卡券ID。
UserCardCode	Code碼。
ModifyBonus	變動的積分值。
ModifyBalance	變動的余額值。

使用網頁調試工具調試該接口

2.10 庫存報警事件

當某個card_id的初始庫存數(shù)大于200且當前庫存小于等于100時，用戶嘗試領券會觸發(fā)發(fā)送事件給商戶，事件每隔12h發(fā)送一次。

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號
FromUserName	發(fā)送方，微信
CreateTime	消息創(chuàng)建時間（整型）
MsgType	消息類型，event
Event	事件類型，card_sku_remind庫存報警
CardId	卡券ID
Detail	報警詳細信息

使用網頁調試工具調試該接口

2.11 券點流水詳情事件

當商戶朋友的券券點發(fā)生變動時，微信服務器會推送消息給商戶服務器。

<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>

參數(shù)說明：

參數(shù)	說明
ToUserName	開發(fā)者微信號
FromUserName	發(fā)送方，微信
CreateTime	消息創(chuàng)建時間（整型）
MsgType	消息類型，event
Event	事件類型，card_pay_order券點流水詳情事件
OrderId	本次推送對應的訂單號
Status	本次訂單號的狀態(tài),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 已回退,系統(tǒng)失敗 ORDER_STATUS_HAS_RECEIPT 已開發(fā)票
CreateOrderTime	購買券點時，支付二維碼的生成時間
PayFinishTime	購買券點時，實際支付成功的時間
Desc	支付方式，一般為微信支付充值
FreeCoinCount	剩余免費券點數(shù)量
PayCoinCount	剩余付費券點數(shù)量
RefundFreeCoinCount	本次變動的免費券點數(shù)量
RefundPayCoinCount	本次變動的付費券點數(shù)量
OrderType	所要拉取的訂單類型 ORDER_TYPE_SYS_ADD 平臺贈送券點 ORDER_TYPE_WXPAY 充值券點 ORDER_TYPE_REFUND 庫存未使用回退券點 ORDER_TYPE_REDUCE 券點兌換庫存 ORDER_TYPE_SYS_REDUCE 平臺扣減
Memo	系統(tǒng)備注，說明此次變動的緣由，如開通賬戶獎勵、門店獎勵、核銷獎勵以及充值、扣減。
ReceiptInfo	所開發(fā)票的詳情

使用網頁調試工具調試該接口

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>

參數(shù)說明

參數(shù)	說明
ToUserName	開發(fā)者微信號
FromUserName	發(fā)送方帳號（一個OpenID）
CreateTime	消息創(chuàng)建時間（整型）
MsgType	消息類型，event
CardId	卡券ID
UserCardCode	卡券Code碼

使用網頁調試工具調試該接口

以上內容是否對您有幫助：

← 微信公眾號管理卡券

微信平臺會員卡專區(qū)（一） →

寫筆記

我要補充