微信平臺(tái)會(huì)員卡專區(qū)(一)

2019-03-14 15:10 更新

會(huì)員卡專區(qū)

會(huì)員卡升級(jí)公告

2016年5月15日起,微信卡券團(tuán)隊(duì)對(duì)會(huì)員卡能力進(jìn)行全面升級(jí)。在原有能力基礎(chǔ)上進(jìn)行以下能力升級(jí),旨在幫助商家更好地進(jìn)行會(huì)員管理。

-強(qiáng)化客戶端一級(jí)入口:會(huì)員到店即用,快速定位商戶會(huì)員卡;

-自定義卡面能力:開發(fā)者可以根據(jù)會(huì)員身份設(shè)置不同的卡面背景;

-門店掃碼方案:新用戶到店掃碼領(lǐng)卡,老用戶到店掃碼快速打開會(huì)員卡,實(shí)現(xiàn)會(huì)員點(diǎn)餐、買單等多種功能

-支付即會(huì)員:支持開發(fā)者設(shè)置微信支付后為用戶下發(fā)領(lǐng)卡消息,顧客支付即會(huì)員,快速拉新;

-運(yùn)營(yíng)策略調(diào)整:會(huì)員卡新增開放類目限制,自4月20日起,僅限會(huì)員卡類目?jī)?nèi)的商戶新建會(huì)員卡,原有會(huì)員卡不受影響,詳情請(qǐng)見:《會(huì)員卡公告》

更新日志

版本號(hào)更新內(nèi)容更新時(shí)間
V1.0

1.支持創(chuàng)建/更新會(huì)員卡直接拉出支付付款碼付款,微信支付

  進(jìn)一步打通會(huì)員卡

2.一鍵激活接口升級(jí),一鍵激活支持商戶設(shè)置綁定老會(huì)員url、

 設(shè)置自定義選項(xiàng)以及設(shè)置用戶填寫一鍵激活信息后跳轉(zhuǎn)至商戶

 頁(yè)面

2016-6-20
V1.1

1.開發(fā)者在變動(dòng)積分/余額消息時(shí),支持開發(fā)者控制發(fā)/不發(fā)系統(tǒng)模板消息

2.支持商戶設(shè)置某一張卡支持用戶修改信息

2016-8-16

在原有能力的基礎(chǔ)上,微信卡券團(tuán)隊(duì)將對(duì)會(huì)員卡新增自定義卡面、門店掃碼方案、支付后模板消息、按會(huì)員標(biāo)簽分組群發(fā)消息等能力,卡券消息能力也進(jìn)行了升級(jí),旨在幫助商家更好地進(jìn)行會(huì)員管理。

1.新版會(huì)員卡介紹

    -(a)增加自定義背景,開發(fā)者可以設(shè)置;

    -(b)卡券消息升級(jí),積分/余額變動(dòng)通過模板消息自動(dòng)發(fā)送,可攜帶營(yíng)銷信息。

卡券消息升級(jí)

     (a)

消息模板2
 (b)

2.須知

閱讀該部分之前請(qǐng)先閱讀《微信公眾平臺(tái)開發(fā)概述》、《開始開發(fā)》以及《微信卡券接口說明,確保你能了解公眾平臺(tái)和卡券接口的基本術(shù)語和調(diào)用方法。

一般地,會(huì)員卡的接口調(diào)用順序可參考以下流程:

會(huì)員卡的接口調(diào)用順序

3.會(huì)員卡玩法介紹


     門店掃碼方案                      會(huì)員卡快速買單              會(huì)員卡與CRM打通


               門店掃碼方案                                                會(huì)員卡快速買單                                    會(huì)員卡與CRM打通




             會(huì)員卡與支付系統(tǒng)打通                           老會(huì)員綁定

          會(huì)員卡與支付系統(tǒng)打通                                            老會(huì)員綁定


4.創(chuàng)建會(huì)員卡接口詳情

4.1 創(chuàng)建會(huì)員卡接口

    支持開發(fā)者調(diào)用該接口創(chuàng)建會(huì)員卡,并獲取card_id,用于投放。調(diào)用該接口前,請(qǐng)開發(fā)者詳讀《創(chuàng)建卡券接口,快速錄入會(huì)員卡卡面必要信息。

接口調(diào)用請(qǐng)求說明

HTTP請(qǐng)求方式: POST
URL:https://api.weixin.qq.com/card/create?access_token=ACCESS_TOKEN

參數(shù)說明

參數(shù)            是否必須            說明            
access_token            是            調(diào)用接口憑證            
POST數(shù)據(jù)            是            JSON數(shù)據(jù)            






POST數(shù)據(jù)示例:

{
    "card": {
        "card_type": "MEMBER_CARD",
        "member_card": {
            "background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/",
            "base_info": {
                "logo_url": "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZ/0",
                "brand_name": "海底撈",
                "code_type": "CODE_TYPE_TEXT",
                "title": "海底撈會(huì)員卡",
                "color": "Color010",
                "notice": "使用時(shí)向服務(wù)員出示此券",
                "service_phone": "020-88888888",
                "description": "不可與其他優(yōu)惠同享",
                "date_info": {
                    "type": "DATE_TYPE_PERMANENT"
                },
                "sku": {
                    "quantity": 50000000
                },
                "get_limit": 3,
                "use_custom_code": false,
                "can_give_friend": true,
                "location_id_list": [
                    123,
                    12321
                ],
                "custom_url_name": "立即使用",
                "custom_url": "http://weixin.qq.com",
                "custom_url_sub_title": "6個(gè)漢字tips",
                "promotion_url_name": "營(yíng)銷入口1",
                "promotion_url": "http://www.qq.com",
                "need_push_on_view": true
            },
            "supply_bonus": true,
            "supply_balance": false,
            "prerogative": "test_prerogative",
            "auto_activate": true,
            "custom_field1": {
                "name_type": "FIELD_NAME_TYPE_LEVEL",
                "url": "http://www.qq.com"
            },
            "activate_url": "http://www.qq.com",
            "custom_cell1": {
                "name": "使用入口2",
                "tips": "激活后顯示",
                "url": "http://www.xxx.com"
            },
            "bonus_rule": {
                "cost_money_unit": 100,
                "increase_bonus": 1,
                "max_increase_bonus": 200,
                "init_increase_bonus": 10,
                "cost_bonus_unit": 5,
                "reduce_money": 100,
                "least_money_to_use_bonus": 1000,
                "max_reduce_bonus": 50
            },
            "discount": 10
        }
    }
}

接口字段對(duì)應(yīng)表

接口字段對(duì)應(yīng)表

參數(shù)說明

參數(shù)名            必填            類型            描述            
card_type            是            string(24)            會(huì)員卡類型。            

background_                

pic_url                

否            string(128)            

商家自定義會(huì)員卡背景圖,須                

先調(diào)用上傳圖片接口將背景圖上傳至CDN,否則報(bào)錯(cuò),

卡面設(shè)計(jì)請(qǐng)遵循微信會(huì)員卡自定義背景設(shè)計(jì)規(guī)范  ,像素大小控制在

1000像素*600像素以下

          

base_info            是            JSON結(jié)構(gòu)            基本的卡券數(shù)據(jù),見下表,所有卡券類型通用。            
prerogative            是            

string(3072)                 

會(huì)員卡特權(quán)說明。            
auto_activate            否            bool            設(shè)置為true時(shí)用戶領(lǐng)取會(huì)員卡后系統(tǒng)自動(dòng)將其激活,無需調(diào)用激活接口。            
wx_activate            否            bool            設(shè)置為true時(shí)會(huì)員卡支持一鍵開卡,不允許同時(shí)傳入activate_url字段,否則設(shè)置wx_activate失效。填入該字段后仍需調(diào)用接口設(shè)置開卡項(xiàng)方可生效。            
supply_bonus            是            bool            顯示積分,填寫true或false,如填寫true,積分相關(guān)字段均為必填。            
bonus_url            否            string(128)            設(shè)置跳轉(zhuǎn)外鏈查看積分詳情。僅適用于積分無法通過激活接口同步的情況下使用該字段。            
supply_balance            是            bool            是否支持儲(chǔ)值,填寫true或false。如填寫true,儲(chǔ)值相關(guān)字段均為必填。            
balance_url            否            string(128)            設(shè)置跳轉(zhuǎn)外鏈查看余額詳情。僅適用于余額無法通過激活接口同步的情況下使用該字段。            
custom_field1            否            JSON結(jié)構(gòu)            自定義會(huì)員信息類目,會(huì)員卡激活后顯示,包含name_type和url字段            
custom_field2            否            JSON結(jié)構(gòu)            自定義會(huì)員信息類目,會(huì)員卡激活后顯示,包含name_type和url字段            
custom_field3            否            JSON結(jié)構(gòu)            自定義會(huì)員信息類目,會(huì)員卡激活后顯示,包含name_type和url字段            
name_type            否            string(24)            

會(huì)員信息類目名稱。

FIELD_NAME_TYPE_LEVEL              等級(jí)

FIELD_NAME_TYPE_COUPON        優(yōu)惠券                

FIELD_NAME_TYPE_STAMP            印花

FIELD_NAME_TYPE_DISCOUNT      折扣

FIELD_NAME_TYPE_ACHIEVEMEN  成就

FIELD_NAME_TYPE_MILEAGE          里程                 

url            否            string(128)            點(diǎn)擊類目跳轉(zhuǎn)外鏈url            
bonus_cleared            否            string(128)            積分清零規(guī)則。            
bonus_rules            否            string(128)            積分規(guī)則。            
balance_rules            否            string(128)            儲(chǔ)值說明。            
activate_url            是            string(128)            激活會(huì)員卡的url。            
custom_cell1            否            JSON結(jié)構(gòu)            自定義會(huì)員信息類目,會(huì)員卡激活后顯示。            
name            是            string(15)            入口名稱。            
tips            是            string(18)            入口右側(cè)提示語,6個(gè)漢字內(nèi)。            
url            是            string(128)            入口跳轉(zhuǎn)鏈接。            
bonus_rule            否            JSON結(jié)構(gòu)            積分規(guī)則。用于微信買單功能            
cost_money_unit            否            int            消費(fèi)金額。以分為單位。            
increase_bonus            否            int            對(duì)應(yīng)增加的積分。            

max_increase_bonus                 

否            int            用戶單次可獲取的積分上限。            

init_increase_bonus                 

否            int            初始設(shè)置積分。            
cost_bonus_unit            否            int            每使用5積分。            
reduce_money            否            int            抵扣xx元,(這里以分為單位)            

least_money_to_use_bonus                 

否            int            抵扣條件,滿xx元(這里以分為單位)可用。            

max_reduce_bonus                 

否            int            抵扣條件,單筆最多使用xx積分。            
discount            否            int            折扣,該會(huì)員卡享受的折扣優(yōu)惠,填10就是九折。            








































































base_info字段:

參數(shù)名            必填            類型            描述            
logo_url            是            string(128)            卡券的商戶logo,建議像素為300*300。            
code_type            是            string(16)            

Code展示類型,                

"CODE_TYPE_TEXT"                

文本                

"CODE_TYPE_BARCODE"                

一維碼                 

"CODE_TYPE_QRCODE"                

二維碼                

"CODE_TYPE_ONLY_QRCODE"

僅顯示二維碼            

"CODE_TYPE_ONLY_BARCODE"

僅顯示一維碼   

"CODE_TYPE_NONE"                

不顯示任何碼型

brand_name            是            string(36)            商戶名字,字?jǐn)?shù)上限為12個(gè)漢字。            
title            是            string(27)            

卡券名,字?jǐn)?shù)上限為9個(gè)漢字

(建議涵蓋卡券屬性、服務(wù)及金額)。            

color            是            string(16)            券顏色。按色彩規(guī)范標(biāo)注填寫Color010-Color100            
notice            是            string(48)            卡券使用提醒,字?jǐn)?shù)上限為16個(gè)漢字。            
description            是            string(3072)            卡券使用說明,字?jǐn)?shù)上限為1024個(gè)漢字。            
sku            是            JSON結(jié)構(gòu)            商品信息。            
quantity            是            int            卡券庫(kù)存的數(shù)量,不支持填寫0,上限為100000000。            
date_info            是            JSON結(jié)構(gòu)            使用日期,有效期的信息。            
type            是            string            

使用時(shí)間的類型

支持固定時(shí)長(zhǎng)有效類型

固定日期有效類型

永久有效類型(DATE_TYPE_PERMANENT)

begin_timestamp                 

否            

unsigned int                

type為DATE_TYPE_FIX_TIME_RANGE時(shí)專用,

表示起用時(shí)間。從1970年1月1日00:00:00至起用時(shí)間的秒數(shù)

(東八區(qū)時(shí)間,單位為秒)            

end_timestamp                 

否            unsigned int            

type為DATE_TYPE_FIX_TERM_RANGE時(shí)專用,表示結(jié)束時(shí)

(東八區(qū)時(shí)間,單位為秒)             

fixed_term            否            int            type為DATE_TYPE_FIX_TERM時(shí)專用,表示自領(lǐng)取后多少天內(nèi)有效,領(lǐng)取后當(dāng)天有效填寫0(單位為天)            

fixed_begin_term                 

否            int            type為DATE_TYPE_FIX_TERM時(shí)專用,表示自領(lǐng)取后多少天開始生效。(單位為天)            

use_custom_code                 

否            bool            

是否自定義Code碼。填寫true或false,默認(rèn)為false

通常自有優(yōu)惠碼系統(tǒng)的開發(fā)者選擇自定義Code碼

bind_openid            否            bool            是否指定用戶領(lǐng)取,填寫true或false。默認(rèn)為false            
service_phone            否            string(24)            客服電話         
location_id_list            否            array            門店位置ID。調(diào)用POI門店管理接口獲取門店位置ID。            
use_all_locations
bool會(huì)員卡是否支持全部門店,填寫后商戶門店更新時(shí)會(huì)自動(dòng)同步至卡券
center_title            string(18)            

卡券中部居中的按鈕,僅在卡券激活后且可用狀態(tài)時(shí)顯示                

center_sub                

_title                

            string(24)            

顯示在入口下方的提示語,僅在卡券激活后且可用狀態(tài)時(shí)顯示                

center_url            否            string(128)            

頂部居中的url,僅在卡券激活后且可用狀態(tài)時(shí)顯示                

custom_url                

_name                

否            string(15)            自定義跳轉(zhuǎn)外鏈的入口名字。            
custom_url            否            string(128)            自定義跳轉(zhuǎn)的URL。            

custom_url_sub_title                 

否            string(18)            顯示在入口右側(cè)的提示語。            

promotion_url_name                 

否            string(15)            營(yíng)銷場(chǎng)景的自定義入口名稱。            

promotion_url                 

否            string(128)            入口跳轉(zhuǎn)外鏈的地址鏈接。            

promotion_url_sub_title                 

否            string(18)            顯示在營(yíng)銷入口右側(cè)的提示語。            
get_limit            否            int            每人可領(lǐng)券的數(shù)量限制,建議會(huì)員卡每人限領(lǐng)一張            
can_share            否            bool            卡券領(lǐng)取頁(yè)面是否可分享,默認(rèn)為true            

can_give_friend                 

否            bool            卡券是否可轉(zhuǎn)贈(zèng),默認(rèn)為true            

need_push_on_view                 

否            bool            填寫true為用戶點(diǎn)擊進(jìn)入會(huì)員卡時(shí)推送事件,默認(rèn)為false。        






































































返回說明

{   
"errcode":0,   
"errmsg":"ok",   
"card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI"
}
參數(shù)名            描述            
errcode            錯(cuò)誤碼,0為正常。            
errmsg            錯(cuò)誤信息。            
card_id            卡券ID。            







開發(fā)者注意事項(xiàng)

1. 僅部分類目可創(chuàng)建會(huì)員卡,非開放類目將返回錯(cuò)誤碼,類目明細(xì)見會(huì)員卡公告

2.創(chuàng)建會(huì)員卡時(shí),需設(shè)置會(huì)員卡激活后呈現(xiàn)的信息類目,目前支持積分、余額、等級(jí)、優(yōu)惠券、里程、印花、成就、折扣等類型,微信6.2以上版本顯示會(huì)員信息類目的上限為3個(gè),即創(chuàng)建時(shí)類目字段supply_bonus 、supply_balance、 custom_field1、custom_field2 、custom_field3最多選擇三項(xiàng)填寫。

3.創(chuàng)建卡券時(shí),開發(fā)者填入的時(shí)間戳須注意時(shí)間戳溢出時(shí)間,設(shè)置的時(shí)間戳須早于2038年1月19日,若要設(shè)置更久的有效期,可以選擇永久有效類型的有效期。


4.2 獲取會(huì)員卡審核結(jié)果

    調(diào)用接口成功創(chuàng)建會(huì)員卡后,會(huì)由系統(tǒng)自動(dòng)提交審核,審核結(jié)果將在三個(gè)工作日內(nèi)以事件形式告知開發(fā)者,同時(shí)支持調(diào)用接口主動(dòng)查詢卡券狀態(tài)。

審核事件推送

    生成的卡券通過審核時(shí),微信會(huì)把這個(gè)事件推送到開發(fā)者填寫的URL,詳情見:審核事件推送,會(huì)員卡審核通過后可以正式投放會(huì)員卡。

  4.3 設(shè)置測(cè)試白名單接口

     若會(huì)員卡暫時(shí)未審核通,開發(fā)者可以將測(cè)試人員的微信號(hào)設(shè)置成白名單,領(lǐng)取未審核通過的卡券。白名單狀態(tài)領(lǐng)取的卡信息不隨卡券實(shí)時(shí)更新,請(qǐng)開發(fā)者注意。

5  投放會(huì)員卡接口詳情

    目前微信會(huì)員卡支持通過掃描二維碼、在網(wǎng)頁(yè)直接點(diǎn)擊(參考JS-SDK網(wǎng)頁(yè)接口)、卡券貨架、公眾號(hào)群發(fā)以及公眾號(hào)被動(dòng)回復(fù)消息領(lǐng)取,開發(fā)者可以選擇一種或者多種。請(qǐng)參考以下各種投放方式詳情。

特別注意

1. 開發(fā)者調(diào)用接口投放的會(huì)員卡為無會(huì)員信息的“卡套”,會(huì)員卡編號(hào)、積分、余額等信息需在用戶領(lǐng)取會(huì)員卡后調(diào)用激活/綁定會(huì)員卡接口更新上。

2. 調(diào)用激活/綁定會(huì)員卡接口的憑證為Code碼及card_id,開發(fā)者需在調(diào)用投放會(huì)員卡時(shí)通過接口或領(lǐng)取卡券事件記錄code碼與會(huì)員OpenID的關(guān)系。

5.1 創(chuàng)建二維碼接口

    創(chuàng)建會(huì)員卡二維碼,打印后置于店內(nèi),顧客掃碼領(lǐng)取會(huì)員卡,掃描下方二維碼體驗(yàn)領(lǐng)取,若已領(lǐng)取可掃碼快速打開會(huì)員卡。接口詳情見:創(chuàng)建二維碼接口

會(huì)員卡二維碼

5.2 網(wǎng)頁(yè)內(nèi)單張/批量添加卡券接口

    微信提供addCard接口供商戶前端網(wǎng)頁(yè)調(diào)用,用于將一張或多張卡券添加到用戶卡包。詳情見批量添加卡券接口

  批量添加卡券接口

 (微信掃一掃>微信卡券接口>addcard接口)

5.3 通過卡券貨架投放會(huì)員卡

卡券貨架簡(jiǎn)介

    卡券貨架支持開發(fā)者通過調(diào)用接口生成一個(gè)卡券領(lǐng)取H5頁(yè)面,并獲取頁(yè)面鏈接,進(jìn)行卡券投放動(dòng)作。


卡券貨架簡(jiǎn)介

5.4 公眾號(hào)消息投放會(huì)員卡

    開發(fā)者也可以通過公眾號(hào)群發(fā)消息或者客服消息為用戶發(fā)送一張會(huì)員卡。

5.5 記錄用戶領(lǐng)卡行為

    用戶領(lǐng)取會(huì)員卡后,微信會(huì)給開發(fā)者服務(wù)器推送領(lǐng)取會(huì)員卡事件通知,以便開發(fā)者記錄用戶OpenID與會(huì)員卡code的關(guān)聯(lián)關(guān)系,并可以通過事件內(nèi)的參數(shù)區(qū)分領(lǐng)取渠道(見1.5)。

5.6 統(tǒng)計(jì)投放渠道數(shù)據(jù)

    為方便開發(fā)者統(tǒng)計(jì)各渠道的卡券投放數(shù)據(jù),新增字段outer_id。將不同設(shè)值的outer_id填入card_ext的JSON結(jié)構(gòu)中,當(dāng)用戶領(lǐng)取卡券時(shí)會(huì)將相應(yīng)設(shè)值的outer_id帶入領(lǐng)取事件推送中,推送至開發(fā)者服務(wù)器。

示例: 在二維碼投放方式中設(shè)置outer_id為1

{
    "action_name": "QR_CARD",
    "action_info": {
        "card": {
            "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
            "code": "198374613512",
            "openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
            "expire_seconds": 1800,
            "is_unique_code": false,
            "outer_id": 1
        }
    }
}


領(lǐng)取事件XML文件

<xml> 
  <ToUserName><![CDATA[toUser]]></ToUserName>  
  <FromUserName><![CDATA[FromUser]]></FromUserName>  
  <FriendUserName><![CDATA[FriendUser]]></FriendUserName>  
  <CreateTime>123456789</CreateTime>  
  <MsgType><![CDATA[event]]></MsgType>  
  <Event><![CDATA[user_get_card]]></Event>  
  <CardId><![CDATA[cardid]]></CardId>  
  <IsGiveByFriend>1</IsGiveByFriend>  
  <UserCardCode><![CDATA[12312312]]></UserCardCode>  
  <OuterId>1</OuterId>
</xml>

6 激活會(huì)員卡

    當(dāng)用戶領(lǐng)取會(huì)員卡“卡套”后,支持調(diào)用該接口對(duì)會(huì)員卡進(jìn)行激活,并設(shè)置會(huì)員信息的初始值,如積分、余額、等級(jí)、會(huì)員卡編號(hào)等會(huì)員信息。目前,微信會(huì)員卡支持三種激活方式,分別是接口激活、一鍵激活和自動(dòng)激活。

開發(fā)者注意事項(xiàng)

1.開發(fā)者可以根據(jù)業(yè)務(wù)場(chǎng)景需要選擇合適的激活流程。三種激活流方法只能選擇一種;

2.激活會(huì)員卡需傳入用戶領(lǐng)取時(shí)獲取的Code碼,將該Code碼對(duì)應(yīng)設(shè)置會(huì)員卡編號(hào)membership_number。

6.1 接口激活

激活方式說明

    接口激活通常需要開發(fā)者開發(fā)用戶填寫資料的網(wǎng)頁(yè)。通常有兩種激活流程:

   1. 用戶必須在填寫資料后才能領(lǐng)卡,領(lǐng)卡后開發(fā)者調(diào)用激活接口為用戶激活會(huì)員卡;

  2. 是用戶可以先領(lǐng)取會(huì)員卡,點(diǎn)擊激活會(huì)員卡跳轉(zhuǎn)至開發(fā)者設(shè)置的資料填寫頁(yè)面,填寫完成后開發(fā)者調(diào)用激活接口為用戶激活會(huì)員卡。

接口詳情

接口調(diào)用請(qǐng)求說明

HTTP請(qǐng)求方式: POST
URL:https://api.weixin.qq.com/card/membercard/activate?access_token=TOKEN

參數(shù)說明

參數(shù)            是否必須            說明            
access_token            是            調(diào)用接口憑證            
POST數(shù)據(jù)            是            JSON數(shù)據(jù)            
{
    "init_bonus": 100,
    "init_balance": 200,
    "membership_number": "AAA00000001",
    "code": "12312313",
    "card_id": "xxxx_card_id",
    "background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
    "init_custom_field_value1": "xxxxx"
}
參數(shù)名            必填            類型            描述            
membership_number            是            string(20)            會(huì)員卡編號(hào),由開發(fā)者填入,作為序列號(hào)顯示在用戶的卡包里??膳cCode碼保持等值。            
code            是            string(20)            創(chuàng)建會(huì)員卡時(shí)獲取的初始code。            
card_id
否     string(32)    卡券ID,自定義code卡券必填

background_pic_url        

    string(128) 

商家自定義會(huì)員卡背景圖,須                

先調(diào)用上傳圖片接口將背景圖上傳至CDN,否則報(bào)錯(cuò),

卡面設(shè)計(jì)請(qǐng)遵循微信會(huì)員卡自定義背景設(shè)計(jì)規(guī)范                

activate_begin_time            否            unsigned int            激活后的有效起始時(shí)間。若不填寫默認(rèn)以創(chuàng)建時(shí)的 data_info 為準(zhǔn)。Unix時(shí)間戳格式。            
activate_end_time            否            unsigned int            激活后的有效截至?xí)r間。若不填寫默認(rèn)以創(chuàng)建時(shí)的 data_info 為準(zhǔn)。Unix時(shí)間戳格式。            
init_bonus            否            int            初始積分,不填為0。            
init_balance            否            int            初始余額,不填為0。            
init_custom_field_value1            否            string(12)            創(chuàng)建時(shí)字段custom_field1定義類型的初始值,限制為4個(gè)漢字,12字節(jié)。            
init_custom_field_value2            否            string(12)            創(chuàng)建時(shí)字段custom_field2定義類型的初始值,限制為4個(gè)漢字,12字節(jié)。            
init_custom_field_value3            否            string(12)            創(chuàng)建時(shí)字段custom_field3定義類型的初始值,限制為4個(gè)漢字,12字節(jié)。            






















返回說明

數(shù)據(jù)示例:

{   "errcode":0,   "errmsg":"ok" }
參數(shù)名            描述            
errcode            錯(cuò)誤碼,0為正常。            
errmsg            錯(cuò)誤信息。            






6.2 一鍵激活 

6.2.1 普通一鍵激活

     一鍵激活是微信提供的快速便捷的激活方案,用戶領(lǐng)取后點(diǎn)擊“激活會(huì)員卡”會(huì)跳轉(zhuǎn)至官方的資料填寫頁(yè)面,微信會(huì)自動(dòng)拉取該用戶之前填寫過的開卡信息,用戶無需重復(fù)填寫, 同時(shí)避免了手機(jī)號(hào)驗(yàn)證的過程,從而實(shí)現(xiàn)一鍵激活的目的,提高了開卡率。具體流程如下圖:

一鍵激活流程圖

步驟一:在創(chuàng)建接口填入wx_activate字段

接口說明

    設(shè)置微信一鍵開卡功能,現(xiàn)支持在創(chuàng)建會(huì)員卡時(shí)填入指定字段指定要一鍵激活,member_card中增加"wx_activate": true。 

    若商戶使用了自定義卡號(hào),開發(fā)者可以設(shè)置用戶填寫信息后跳轉(zhuǎn)至商戶的網(wǎng)頁(yè),并由開發(fā)者進(jìn)行激活。

參數(shù)說明

參數(shù)            是否必須            說明            
member_card              
wx_activate            否            填寫true or false            

POST數(shù)據(jù)示例:

{    
"card": {      
 ························     
 ························    
"member_card": {            
"wx_activate": true        
}    
}
}

開發(fā)者注意事項(xiàng)

1.填入了自動(dòng)激活auto_activate字段,激活鏈接activate_url和一鍵開卡接口設(shè)置都會(huì)失效;

2.若同時(shí)傳入了activate_url,則一鍵開卡接口設(shè)置會(huì)失效;

3.建議開發(fā)者activate_url、auto_activate和wx_activate只填寫一項(xiàng)。

步驟二:設(shè)置開卡字段接口

    開發(fā)者在創(chuàng)建時(shí)填入wx_activate字段后,需要調(diào)用該接口設(shè)置用戶激活時(shí)需要填寫的選項(xiàng),否則一鍵開卡設(shè)置不生效。

開卡字段接口

接口調(diào)用請(qǐng)求說明

HTTP請(qǐng)求方式: POST
URL:https://api.weixin.qq.com/card/membercard/activateuserform/set?access_token=TOKEN

參數(shù)說明

參數(shù)            是否必須            說明            
access_token            是            調(diào)用接口憑證            
POST數(shù)據(jù)            是            JSON數(shù)據(jù)            
{
    "card_id": "pbLatjnrwUUdZI641gKdTMJzHGfc",
    "service_statement": {
        "name": "會(huì)員守則",
        "url": "www.qq.com"
    },
    "bind_old_card": {
        "name": "老會(huì)員綁定",
        "url": "www.weixin.qq.com"
    },
    "required_form": {
        "can_modify":false,
        "rich_field_list": [
            {
                "type": "FORM_FIELD_RADIO",
                "name": "興趣",
                "values": [
                    "鋼琴",
                    "舞蹈",
                    "足球"
                ]
            },
            {
                "type": "FORM_FIELD_SELECT",
                "name": "喜好",
                "values": [
                    "郭敬明",
                    "韓寒",
                    "南派三叔"
                ]
            },
            {
                "type": "FORM_FIELD_CHECK_BOX",
                "name": "職業(yè)",
                "values": [
                    "賽車手",
                    "旅行家"
                ]
            }
        ],
        "common_field_id_list": [
            "USER_FORM_INFO_FLAG_MOBILE"
        ]
    },
    "optional_form": {
        "can_modify":false,
        "common_field_id_list": [
            "USER_FORM_INFO_FLAG_LOCATION",
            "USER_FORM_INFO_FLAG_BIRTHDAY"
        ],
        "custom_field_list": [
            "喜歡的電影"
        ]
    }
}
參數(shù)名            必填            類型            描述            
card_id            是            string(32)            卡券ID。            
required_form            否            JSON結(jié)構(gòu)            會(huì)員卡激活時(shí)的必填選項(xiàng)。            
optional_form            否            JSON結(jié)構(gòu)            會(huì)員卡激活時(shí)的選填項(xiàng)。            
can_modifybool

當(dāng)前結(jié)構(gòu)(required_form或者optional_form )內(nèi)

的字段是否允許用戶激活后再次修改,商戶設(shè)置為true

時(shí),需要接收相應(yīng)事件通知處理修改事件

common_field_id_list            否            arry            微信格式化的選項(xiàng)類型。見以下列表。            
custom_field_list            否            arry            自定義選項(xiàng)名稱。            
rich_field_list            否            arry            自定義富文本類型,包含以下三個(gè)字段            
type
           
否            string(32)            

富文本類型                

FORM_FIELD_RADIO   自定義單選                

FORM_FIELD_SELECT   自定義選擇項(xiàng)                

FORM_FIELD_CHECK_BOX 自定義多選                

name            否            string(32)            字段名            
values            否            arry            選擇項(xiàng)            
service_statement
           
否            JSON結(jié)構(gòu)            

服務(wù)聲明,用于放置商戶會(huì)員卡守                

則                

name            否            string(32)            會(huì)員聲明字段名稱            
url            否            string(128)            自定義url            
bind_old_card            否            JSON結(jié)構(gòu)            綁定老會(huì)員鏈接            
name            否            string(32)            鏈接名稱            
url            否            string(128)            自定義url            

common_field_id_list,支持開發(fā)者使用以下選項(xiàng)類型

字段值            描述            
USER_FORM_INFO_FLAG_MOBILE            手機(jī)號(hào)            
USER_FORM_INFO_FLAG_SEX性別
USER_FORM_INFO_FLAG_NAME            姓名            
USER_FORM_INFO_FLAG_BIRTHDAY            生日            
USER_FORM_INFO_FLAG_IDCARD            身份證            
USER_FORM_INFO_FLAG_EMAIL            郵箱            
USER_FORM_INFO_FLAG_LOCATION            詳細(xì)地址            
USER_FORM_INFO_FLAG_EDUCATION_BACKGRO        教育背景            
USER_FORM_INFO_FLAG_CAREER            職業(yè)            
USER_FORM_INFO_FLAG_INDUSTRY            行業(yè)            
USER_FORM_INFO_FLAG_INCOME            收入            
USER_FORM_INFO_FLAG_HABIT            興趣愛好            


步驟三:接收會(huì)員信息事件通知

    用戶填寫、提交資料后,會(huì)有事件推送給商家,開發(fā)者可以在接收到事件通知后調(diào)用激活接口,傳入會(huì)員卡號(hào)、初始積分等信息或者調(diào)用拉取會(huì)員信息接口獲取會(huì)員信息,進(jìn)行會(huì)員管理。

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

<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ā)者微信號(hào)            
FromUserName            發(fā)送方帳號(hào)(一個(gè)OpenID)            
CreateTime            消息創(chuàng)建時(shí)間 (整型)            
MsgType            消息類型,event            
CardId            卡券ID            
UserCardCode            卡券Code碼            

步驟四:同步會(huì)員數(shù)據(jù)

    開發(fā)者可以在接收到事件通知后調(diào)用激活接口,傳入會(huì)員卡號(hào)、初始積分等信息或者調(diào)用拉取會(huì)員信息接口獲取會(huì)員信息。


步驟五:拉取會(huì)員信息接口

接口說明

    支持開發(fā)者根據(jù)CardID和Code查詢會(huì)員信息。

接口調(diào)用請(qǐng)求說明

HTTP請(qǐng)求方式: POST
URL:https://api.weixin.qq.com/card/membercard/userinfo/get?access_token=TOKEN

參數(shù)說明

參數(shù)            是否必須            說明            
POST數(shù)據(jù)            是            JSON數(shù)據(jù)            
access_token            是            調(diào)用接口憑證            

POST數(shù)據(jù)

{   "card_id": "pbLatjtZ7v1BG_ZnTjbW85GYc_E8",   "code": "916679873278"}

返回?cái)?shù)據(jù)

{
    "errcode": 0,
    "errmsg": "ok",
    "openid": "obLatjjwDolFj******wNqRXw",
    "nickname": "*******",
    "membership_number": "658*****445",
    "bonus": 995,
    "sex": "MALE",
    "user_info": {
        "common_field_list": [
            {
                "name": "USER_FORM_INFO_FLAG_MOBILE",
                "value": "15*****518"
            },
            {
                "name": "USER_FORM_INFO_FLAG_NAME",
                "value": "HK"
            },
            {
                "name": "USER_FORM_INFO_FLAG_EDUCATION_BACKGROUND",
                "value": "研究生"
            }
        ],
        "custom_field_list": []
    },
    "user_card_status": "NORMAL",
    "has_active": false
}
參數(shù)名            說明            
errcode            錯(cuò)誤碼,0為正常            
errmsg            錯(cuò)誤信息            
openid            用戶在本公眾號(hào)內(nèi)唯一識(shí)別碼            
nickname            用戶昵稱            
bonus            積分信息            
balance            余額信息            
sex            用戶性別            
user_info            會(huì)員信息            
custom_field_list            開發(fā)者設(shè)置的會(huì)員卡會(huì)員信息類目,如等級(jí)。            
name            會(huì)員信息類目名稱            
value            會(huì)員卡信息類目值,比如等級(jí)值等            
user_card_status            當(dāng)前用戶的會(huì)員卡狀態(tài),NORMAL 正常 EXPIRE 已過期 GIFTING 轉(zhuǎn)贈(zèng)中 GIFT_SUCC 轉(zhuǎn)贈(zèng)成功 GIFT_TIMEOUT 轉(zhuǎn)贈(zèng)超時(shí) DELETE 已刪除,UNAVAILABLE 已失效            
has_active該卡是否已經(jīng)被激活,true表示已經(jīng)被激活,false表示未被激活

6.2.2 跳轉(zhuǎn)型一鍵激活

    跳轉(zhuǎn)型一鍵激活支持用戶在提交會(huì)員開卡資料后跳轉(zhuǎn)至商戶自定義的網(wǎng)頁(yè)。不同于普通一鍵激活,跳轉(zhuǎn)型一鍵激活的激活會(huì)員卡動(dòng)作由商戶完成,商戶可以在跳轉(zhuǎn)到的網(wǎng)頁(yè)內(nèi)做激活、激活獎(jiǎng)勵(lì)、開卡條件判斷等邏輯,同時(shí)也保證了開卡的實(shí)時(shí)性,適合使用自定義卡號(hào)的商戶使用。

    跳轉(zhuǎn)型一鍵激活

    步驟一:在創(chuàng)建/更新接口填入跳轉(zhuǎn)型一鍵激活相關(guān)字段

  若商戶設(shè)置用戶激活后跳轉(zhuǎn)自己的網(wǎng)頁(yè),需要在創(chuàng)建或更新接口傳入以下參數(shù)。

{   
 "card": {        
 "member_card": {    
 ························     
 ························   
 "wx_activate": true,
 "wx_activate_after_submit" : true,   //是否設(shè)置跳轉(zhuǎn)型一鍵激活
 "wx_activate_after_submit_url" : "http://qq.com"      //用戶提交信息后跳轉(zhuǎn)的網(wǎng)頁(yè)
 }   
 }
 }

參數(shù)名            必填            類型            描述            
member_card       是            JSON接口          會(huì)員卡結(jié)構(gòu)體            
wx_activate 否            bool         是否支持一鍵激活,填true或lse            
wx_activate_after_submit            否            bool             是否支持跳轉(zhuǎn)型一鍵激活,填true或lse            
wx_activate_after_submit_url           否            bool             跳轉(zhuǎn)型一鍵激活跳轉(zhuǎn)的地址鏈接           

       步驟二:設(shè)置開卡字段接口

       步驟三:獲取用戶提交資料

       用戶填寫并提交開卡資料后,會(huì)跳轉(zhuǎn)到商戶的網(wǎng)頁(yè),商戶可以在網(wǎng)頁(yè)內(nèi)獲取用戶已填寫的信息并進(jìn)行開卡資質(zhì)判斷,信息確認(rèn)等動(dòng)作。

具體方式如下:

       用戶點(diǎn)擊提交后,微信會(huì)在商戶的url后面拼接獲取用戶填寫信息的參數(shù):activate_ticket、openid、card_id和加密code-encrypt_code,如商戶填寫的wx_activate_after_submit_url為 www.qq.com,則拼接后的url為www.qq.com&card_id=pbLatjvFdsLDUMoN8JqcsGeiMHKk&encrypt_code=Bupk8bb9xxxxxx3rdXV6fClBVtkHQplYohdzGvgDl4%3D&outer_str=&openid=obLatjjwDxxxxxxxoGIdwNqRXw&activate_ticket=fDZv9eMQAFfrNr3XBoqhb%2F%2BMSDM0yjDF6CdiUhC%2BOlEaxb0clsUxxxxxxxxxxxd6yQsjRMRu4kAcKTibYLN5tmHBdll1b6zQRsLF53MpKjGU%3D。

      開發(fā)者可以根據(jù)activate_ticket獲取到用戶填寫的信息,用于開發(fā)者頁(yè)面的邏輯判斷。

    接口說明

    支持開發(fā)者根據(jù)activate_ticket獲取到用戶填寫的信息。

接口調(diào)用請(qǐng)求說明

HTTP請(qǐng)求方式: POST
URL:https://api.weixin.qq.com/card/membercard/activatetempinfo/get?access_token=TOKEN

參數(shù)說明

參數(shù)            是否必須            說明            
POST數(shù)據(jù)            是            JSON數(shù)據(jù)            
access_token            是            調(diào)用接口憑證            

POST數(shù)據(jù)

 {
    "activate_ticket" : "abcdefg"
}

返回?cái)?shù)據(jù)

  {
    "errcode": 0,
    "errmsg": "ok",
    "info": {
        "common_field_list": [
            {
                "name": "USER_FORM_INFO_FLAG_MOBILE",
                "value": "15*****518"
            },
            {
                "name": "USER_FORM_INFO_FLAG_NAME",
                "value": "HK"
            },
            {
                "name": "USER_FORM_INFO_FLAG_EDUCATION_BACKGROUND",
                "value": "研究生"
            }
        ],
        "custom_field_list": []
    }
}  

    步驟四:調(diào)用接口激活會(huì)員卡

    開發(fā)者可以在接收到事件通知后調(diào)用激活接口,傳入會(huì)員卡號(hào)、初始積分等信息或者調(diào)用拉取會(huì)員信息接口獲取會(huì)員信息。

6.3 自動(dòng)激活

接口說明

    設(shè)置會(huì)員卡自動(dòng)激活功能,需在創(chuàng)建會(huì)員卡時(shí)填入指定字段,base_info中增加"auto_activate": true,獲取card_id。 

    值得注意的是,傳入自動(dòng)激活字段auto_activate之后,一鍵開卡設(shè)置和接口激活設(shè)置的激活url均不再顯示,用戶領(lǐng)取卡片之后,系統(tǒng)自動(dòng)幫用戶激活,積分、儲(chǔ)值等自定義顯示信息均為0,開發(fā)者可以通過更新會(huì)員信息接口更新用戶會(huì)員數(shù)據(jù)。

參數(shù)說明

參數(shù)            是否必須            說明            
member_card              
auto_activate            否            填寫true or false            

7 更新會(huì)員信息

    當(dāng)會(huì)員持卡消費(fèi)后,支持開發(fā)者調(diào)用該接口更新會(huì)員信息。會(huì)員卡交易后的每次信息變更需通過該接口通知微信,便于后續(xù)消息通知及其他擴(kuò)展功能。

接口調(diào)用請(qǐng)求說明

HTTP請(qǐng)求方式: POST
URL:https://api.weixin.qq.com/card/membercard/updateuser?access_token=TOKEN

參數(shù)說明

參數(shù)            是否必須            說明            
access_token            是            調(diào)用接口憑證            
POST數(shù)據(jù)            是            JSON數(shù)據(jù)            
{
    "code": "12312313",
    "card_id": "p1Pj9jr90_SQRaVqYI239Ka1erkI",
    "background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
    "record_bonus": "消費(fèi)30元,獲得3積分",
    "bonus": 3000,
    //可以傳入第三方系統(tǒng)記錄的積分全量值"balance": 3000,
    //可以傳入第三方系統(tǒng)記錄的余額全量值"record_balance": "購(gòu)買焦糖瑪琪朵一杯,扣除金額30元。",
    "custom_field_value1": "xxxxx",
    "notify_optional": {
        "is_notify_bonus": false,
        "is_notify_balance": true,
        "is_notify_custom_field1":true
    }
}

    值得注意的是,如果開發(fā)者做不到實(shí)時(shí)同步積分、余額至微信端,我們強(qiáng)烈建議開發(fā)者可以在每天的固定時(shí)間點(diǎn)變更積分,一天不超過三次。當(dāng)傳入的積分值與之前無變化時(shí)(傳入的bonus=原來的bonus),不會(huì)有積分變動(dòng)通知。

參數(shù)說明:

參數(shù)名            必填            類型            示例值            描述            
code            是            string(20)            1231123            卡券Code碼。            
card_id            是            string(32)            

p1Pj9jr90_SQ                

RaVqYI239Ka1erkI                

卡券ID。            

background_pic_url                

            string(128)           

https://mmbiz.qlogo.cn/                


           
支持商家激活時(shí)針對(duì)單個(gè)會(huì)員卡分配自定義的會(huì)員卡背景。            
bonus            是            int            100            需要設(shè)置的積分全量值,傳入的數(shù)值會(huì)直接顯示            
record_bonus            否            string(42)            消費(fèi)30元,獲得3積分            商家自定義積分消耗記錄,不超過14個(gè)漢字。            
balance            是            int            100            需要設(shè)置的余額全量值,傳入的數(shù)值會(huì)直接顯示            
record_balance            否            string(42)            

購(gòu)買焦糖瑪                

琪朵一杯,扣除金額30元。                

商家自定義金額消耗記錄,不超過14個(gè)漢字。            
custom_field_value1            否            string(12)            白金            創(chuàng)建時(shí)字段custom_field1定義類型的最新數(shù)值,限制為4個(gè)漢字,12字節(jié)。            
custom_field_value2            否            string(12)            8折            創(chuàng)建時(shí)字段custom_field2定義類型的最新數(shù)值,限制為4個(gè)漢字,12字節(jié)。            
custom_field_value3            否            string(12)            500            創(chuàng)建時(shí)字段custom_field3定義類型的最新數(shù)值,限制為4個(gè)漢字,12字節(jié)。            

notify_optional

JSON--控制原生消息結(jié)構(gòu)體,包含各字段的消息控制字段

is_notify_bonus

booltrue積分變動(dòng)時(shí)是否觸發(fā)系統(tǒng)模板消息,默認(rèn)為true
is_notify_balancebooltrue余額變動(dòng)時(shí)是否觸發(fā)系統(tǒng)模板消息,默認(rèn)為true
is_notify_custom_field1boolfalse自定義group1變動(dòng)時(shí)是否觸發(fā)系統(tǒng)模板消息,默認(rèn)為false。(2、3同理)

返回說明

數(shù)據(jù)示例:

{
    "errcode": 0,
    "errmsg": "ok",
    "result_bonus": 100,
    "result_balance": 200,
    "openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA"
}
參數(shù)名            描述            
errcode            錯(cuò)誤碼,0為正常            
errmsg            錯(cuò)誤信息            
result_bonus            當(dāng)前用戶積分總額            
result_balance            當(dāng)前用戶預(yù)存總金額            
openid            用戶openid             



以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)