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

2018-07-27 11:04 更新

管理會(huì)員卡

拉取會(huì)員信息(積分查詢)接口

接口說(shuō)明

    支持開(kāi)發(fā)者根據(jù)card_id和Code查詢會(huì)員信息,包括激活資料、積分信息以及余額等信息。

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

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

參數(shù)說(shuō)明

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

POST數(shù)據(jù)

{   "card_id": "pbLatjtZ7v1BG_ZnTjbW85GYc_E8",   "code": "916679873278"}
參數(shù)名            是否必填            說(shuō)明            
cardid            是            查詢會(huì)員卡的cardid            
code            是            所查詢用戶領(lǐng)取到的code值            

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

{
    "errcode": 0,
    "errmsg": "ok",
    "openid": "obLatjjwDolFjRRd3doGIdwNqRXw",
    "nickname": "Fourier",
    "membership_number": "316510891298",
    "bonus": 460,
    "sex": "MALE",
    "user_info": {
        "common_field_list": [
            {
                "name": "USER_FORM_INFO_FLAG_MOBILE",
                "value": "15521328888"
            },
            {
                "name": "USER_FORM_INFO_FLAG_NAME",
                "value": "微信"
            }
        ],
        "custom_field_list": []
    },
    "user_card_status": "NORMAL"
}
參數(shù)名            說(shuō)明            
errcode            錯(cuò)誤碼,0為正常            
errmsg            錯(cuò)誤信息            
openid            用戶在本公眾號(hào)內(nèi)唯一識(shí)別碼            
nickname            用戶昵稱            
bonus            積分信息            
balance            余額信息            
sex            用戶性別            
user_info            會(huì)員信息            
custom_field_list            開(kāi)發(fā)者設(shè)置的會(huì)員卡會(huì)員信息類目,如等級(jí)。            
name            會(huì)員信息類目名稱            
value            會(huì)員卡信息類目值,比如等級(jí)值等            
user_card_status            當(dāng)前用戶會(huì)員卡狀態(tài),NORMAL 正常 EXPIRE 已過(guò)期 GIFTING 轉(zhuǎn)贈(zèng)中 GIFT_SUCC 轉(zhuǎn)贈(zèng)成功 GIFT_TIMEOUT 轉(zhuǎn)贈(zèng)超時(shí) DELETE 已刪除,UNAVAILABLE 已失效            

8.2 更改會(huì)員卡信息接口

接口說(shuō)明

    支持更改會(huì)員卡卡面信息以及卡券屬性信息。

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

HTTP請(qǐng)求方式: POSTURL:https://api.weixin.qq.com/card/update?access_token=TOKEN

參數(shù)說(shuō)明

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

POST數(shù)據(jù)

{
    "card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
    "member_card": {
        "background_pic_url": "https://mmbiz.qlogo.cn/mmbiz/0?wx_fmt=jpeg",
        "base_info": {
            "logo_url": "http:\/\/www.supadmin.cn\/uploads\/allimg\/120216\/1_120216214725_1.jpg",
            "color": "Color010",
            "notice": "使用時(shí)向服務(wù)員出示此券",
            "service_phone": "020-88888888",
            "description": "不可與其他優(yōu)惠同享\n如需團(tuán)購(gòu)券發(fā)票,請(qǐng)?jiān)谙M(fèi)時(shí)向商戶提出\n店內(nèi)均可使用,僅限堂食\n餐前不可打包,餐后未吃完,可打包\n本團(tuán)購(gòu)券不限人數(shù),建議2人使用,超過(guò)建議人數(shù)須另收醬料費(fèi)5元/位\n本單謝絕自帶酒水飲料",
            "location_id_list": [
                123,
                12321,
                345345
            ]
        },
        "bonus_cleared": "aaaaaaaaaaaaaa",
        "bonus_rules": "aaaaaaaaaaaaaa",
        "prerogative": "",
        "auto_activate": true,
        //也可以填寫wx_activate"activate_url":""
    }
}

支持修改字段: 

base_info字段:

參數(shù)名            是否提審            類型            示例值            描述            
logo_url            是            string(128)            

http://mmbiz                

.qpic.cn/                

卡券的商戶logo,建議像素為300*300。            
notice            是            string(48)            

請(qǐng)出示二維                

碼核銷卡券。                

使用提醒,字?jǐn)?shù)上限為16個(gè)漢字。            
description            是            string(3072)            

不可與其                

他優(yōu)惠同享                

使用說(shuō)明。            
service_phone            否            string(24)            40012234            客服電話。            
color            是            string(3072)            Color010            卡券顏色。            
location_id_list            否            string(3072)            1234,2314            支持更新適用門店列表。            
use_all_locations否 booltrue支持全部門店,填入后卡券門店跟隨商戶門店更新而更新
center_title            否            string(18)            立即使用            

會(huì)員卡中部的跳轉(zhuǎn)按鈕名稱                

,建議用作使用用途                

center_sub_title            否            string(24)            到店后使用            會(huì)員卡中部按鈕解釋wording            
center_url            否            string(128)            www.qq.com            會(huì)員卡中部按鈕對(duì)應(yīng)跳轉(zhuǎn)的url            
custom_url_name            否            string(16)            立即使用            自定義跳轉(zhuǎn)入口的名字。            
custom_url            否            string(128)            www.qq.com            自定義跳轉(zhuǎn)的URL。            
custom_url_sub_title            否            string(18)            更多驚喜            顯示在入口右側(cè)的提示語(yǔ)。            
promotion_url_name            否            string(16)            產(chǎn)品介紹。            營(yíng)銷場(chǎng)景的自定義入口名稱。            
promotion_url            否            string(128)            www.qq.com;            入口跳轉(zhuǎn)外鏈的地址鏈接。            

promotion_url_sub_title                 

否            string(18)            賣場(chǎng)大優(yōu)惠。            顯示在營(yíng)銷入口右側(cè)的提示語(yǔ)。            
code_type            否            string(16)            

CODE_TYPE                

_TEXT。                

Code碼展示類型,                

"CODE_TYPE_TEXT"  文本           "CODE_TYPE_BARCODE"一維碼 

"CODE_TYPE_QRCODE 二維碼   

"CODE_TYPE_ONLY_QRCODE" 

僅顯示二維碼              

"CODE_TYPE_ONLY_BARCODE"

僅顯示一維碼    

"CODE_TYPE_NONE"  

不顯示任何碼型

get_limit            否            int            1            每人可領(lǐng)券的數(shù)量限制           
can_share            否            bool            false            卡券原生領(lǐng)取頁(yè)面是否可分享            
can_give_friend            否            bool            false            卡券是否可轉(zhuǎn)贈(zèng)            
date_info            否            Json結(jié)構(gòu)            見(jiàn)上述示例            使用日期,有效期的信息,有效期時(shí)間修改僅支持有效區(qū)間的擴(kuò)大           
type            否            int            1            有效期類型,僅支持更改type為1的時(shí)間戳,不支持填入2           
begin_timestamp            否            unsigned int            14300000            固定日期區(qū)間專用,表示起用時(shí)間。(單位為秒)            
end_timestamp            否            unsigned int            15300000            固定日期區(qū)間專用,表示結(jié)束時(shí)間。結(jié)束時(shí)間僅支持往后延長(zhǎng)。            

會(huì)員卡專屬字段修改:

特別注意,以下支持更新的字段不在基本信息base_info的結(jié)構(gòu)中。

參數(shù)名            是否提審            類型            描述            
background_pic_url            否            string(128)            會(huì)員卡自定義卡面背景圖            
bonus_cleared            是            string(3072)            積分清零規(guī)則。            
bonus_rules            是            string(3072)            積分規(guī)則。            
balance_rules            是            string(3072)            儲(chǔ)值說(shuō)明。            
prerogative            是            string(3072)            特權(quán)說(shuō)明。            
wx_activate            否            bool            

是否開(kāi)通一鍵開(kāi)卡

設(shè)置為true時(shí),該卡將支持一鍵開(kāi)卡詳情見(jiàn)一鍵開(kāi)卡。  

該選項(xiàng)與activate_url互斥。          

auto_activate            否            bool            

是否開(kāi)通自動(dòng)激活

,設(shè)置為true時(shí)用戶領(lǐng)取會(huì)員卡自動(dòng)設(shè)置為激活,

詳情見(jiàn)自動(dòng)激活。            

activate_url否 string(128)
激活鏈接
custom_field1            否            Json結(jié)構(gòu)            自定義會(huì)員信息類目,會(huì)員卡激活后顯示。            
custom_field2            否            Json結(jié)構(gòu)            自定義會(huì)員信息類目,會(huì)員卡激活后顯示。            
custom_field3            否            Json結(jié)構(gòu)            自定義會(huì)員信息類目,會(huì)員卡激活后顯示。            
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            
custom_cell1            否            JSON結(jié)構(gòu)自定義會(huì)員信息類目,會(huì)員卡激活后顯示          
bonus_rule            否            JSON結(jié)構(gòu) 積分規(guī)則結(jié)構(gòu)體,用于微信買單功能            
cost_money_unit            否            int            消費(fèi)金額,以分為單位         
increase_bonus            否            int            根據(jù)以上消費(fèi)金額對(duì)應(yīng)增加的積分           
max_increase_bonus            否            int            單次獲取的積分上限            
init_increase_bonus            否            int            用戶激活后獲得的初始積分      
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)惠           

返回?cái)?shù)據(jù)說(shuō)明

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

{   "errcode":0,   "errmsg":"ok",  "send_check":true}
參數(shù)名            描述            
errcode            錯(cuò)誤碼,0為正常。            
errmsg            錯(cuò)誤信息。            
send_check            此次更新是否需要提審,true為需要,false為不需要。            

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

1. 更改卡券的部分字段后會(huì)重新提交審核,詳情見(jiàn)字段說(shuō)明,更新成功后可通過(guò)調(diào)用查看卡券詳情接口核查更新結(jié)果;

2. 僅填入需要更新的字段,許多開(kāi)發(fā)者在調(diào)用該接口時(shí)會(huì)填入brandname等不支持修改的字段,導(dǎo)致更新不成功。

3. 調(diào)用該接口后更改卡券信息后,請(qǐng)務(wù)必調(diào)用查看卡券詳情接口驗(yàn)證是否已成功更改。

8.3 設(shè)置跟隨推薦

功能介紹

    支持開(kāi)發(fā)者在積分變動(dòng)消息底部,配置卡券或設(shè)置跳轉(zhuǎn)外鏈URL,具體形式如下圖,可以是URL也可以是一張卡券。

領(lǐng)券頁(yè)面

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

一、支持兩種類型的跟隨推薦配置

1. 廣告語(yǔ)+URL,支持商戶配置16個(gè)漢字長(zhǎng)度的文案,及點(diǎn)擊跳轉(zhuǎn)的鏈接。

2. 推薦卡券,支持商戶配置一個(gè)本公眾號(hào)下的卡券。

二、推薦位有效期控制

1. 廣告語(yǔ)+URL類型,支持商戶根據(jù)活動(dòng)期限自定義展示時(shí)間。

2. 推薦卡券類型,由微信后臺(tái)判斷卡券的有效性,當(dāng)卡券已過(guò)期、已被領(lǐng)完、已被置為失效會(huì)自動(dòng)下架展示。

8.3.1 設(shè)置跟隨推薦接口

接口說(shuō)明

    調(diào)用更新卡券信息接口將增推薦位字段 update到已成功通過(guò)審核的卡券。 同時(shí)支持在創(chuàng)建卡券時(shí)填入相應(yīng)字段。


接口詳情

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

http請(qǐng)求方式: POSThttps://api.weixin.qq.com/card/update?access_token=TOKEN

參數(shù)說(shuō)明

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

使用消息配置卡券

{
    "card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
    "member_card": {
        "modify_msg_operation": {
            "card_cell": {
                "end_time": 1452724561,
                "card_id": "p1Pj9jr90_SQRaVqYI239Ka1erkI"
            }
        }
    }
}


使用消息配置URL

{
    "card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
    "member_card": {
        "modify_msg_operation": {
            "url_cell": {
                "end_time": 1452724561,
                "text": "更多優(yōu)惠",
                "url": "www.qq.com"
            }
        }
    }
}

字段說(shuō)明

字段名            說(shuō)明            
card_id            卡券ID。            
modify_msg_operation            積分余額變動(dòng)消息類型            
card_cell            卡券類型的推薦位。Json結(jié)構(gòu)參考示例。            
url_cell            鏈接類型的推薦位。Json結(jié)構(gòu)參考示例。            
card_id            需要在運(yùn)營(yíng)位投放的卡券id            
end_time            推薦位展示的截止時(shí)間。            
text            文本內(nèi)容。            
url            跳轉(zhuǎn)鏈接。            


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

{   "errcode":0,   "errmsg":"ok" }

字段說(shuō)明

字段名            說(shuō)明            
錯(cuò)誤碼            錯(cuò)誤碼,0為正常;43008為商戶沒(méi)有開(kāi)通微信支付權(quán)限;            
errmsg            錯(cuò)誤信息            

8.4 設(shè)置支付即會(huì)員

8.4.1 增加支付即會(huì)員規(guī)則接口

    開(kāi)通微信支付的商戶可以設(shè)置,用戶在微信支付后自動(dòng)為用戶發(fā)送一條領(lǐng)卡消息,用戶點(diǎn)擊消息即可領(lǐng)取會(huì)員卡。   領(lǐng)取會(huì)員卡

接口說(shuō)明

    支持商戶設(shè)置支付即會(huì)員的規(guī)則,可以區(qū)分時(shí)間段和金額區(qū)間發(fā)會(huì)員卡。

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

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

參數(shù)說(shuō)明

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

POST數(shù)據(jù)

{
    "card_id": "xxxxxxxxa",
    "jump_url": "mp.weixin.qq.com/wiki",
    "mchid_list": [
        "123",
        "1234",
        "12345"
    ],
    "begin_time": 146324567,
    "end_time": 147234567,
    "min_cost": 1000,
    "max_cost": 10000000,
    "is_locked": true
}

字段說(shuō)明

字段名            說(shuō)明            
card_id            卡券ID,僅支持非自定義code模式的card_id和預(yù)存code模式的card_id。
jump_url            模板消息跳轉(zhuǎn)的url,可以是商戶自定義的領(lǐng)卡網(wǎng)頁(yè)鏈接            
mchid_list            支持贈(zèng)券規(guī)則的商戶號(hào)列表            
begin_time            規(guī)則生效時(shí)間
           
end_time            規(guī)則結(jié)束時(shí)間            
min_cost            本次規(guī)則生效支付金額下限,與分為單位            
max_cost            本次規(guī)則生效支付金額上限,與分為單位            
is_locked            是否允許其他appid設(shè)置本規(guī)則內(nèi)已經(jīng)設(shè)置過(guò)的商戶號(hào),默認(rèn)為true            

返回?cái)?shù)據(jù)說(shuō)明

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

{
    "errcode": 0,
    "errmsg": "ok",
    "succ_list":[
    "134xxxxxx"
    ],
    "fail_list":[
        {
            "mchid": "xxxxx",
            "errcode": 0,
            "errmsg": "ok",
            "occupy_appid": "wxxxxxxxxxxx"
        },
        {
            "mchid": "xxxxx",
            "errcode": 0,
            "errmsg": "ok",
            "occupy_appid": "wxxxxxxxxxxx"
        }
    ]
}
參數(shù)名            描述            
errcode            錯(cuò)誤碼,0為正常。            
errmsg            錯(cuò)誤信息。            
succ_list            設(shè)置成功的mchid列表            
fail_list            設(shè)置失敗的mchid列表            
mchid            支付的商戶號(hào)            
occupy_appid            設(shè)置失敗原因?yàn)橹貜?fù)設(shè)置時(shí),該mchid當(dāng)前被占用的appid,商戶須使用該appid解除綁定后重新設(shè)置。            

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

1. 會(huì)員卡領(lǐng)卡消息針對(duì)單個(gè)新用戶僅發(fā)送一次,若該用戶已經(jīng)接收或者已經(jīng)領(lǐng)取過(guò)會(huì)員卡則不會(huì)重復(fù)發(fā)送;

  2. 通過(guò)該規(guī)則設(shè)置的card_id的制券appid必須和當(dāng)前mch_id的主體appid一致,否則報(bào)錯(cuò)72001;

  3.僅支持會(huì)員卡類型的卡券,否則報(bào)錯(cuò):72003;

  4.設(shè)置支付即會(huì)員時(shí),須確認(rèn)調(diào)用接口的appid和當(dāng)前card_id主體一致,以及appid與mchid有綁定關(guān)系,否則報(bào)錯(cuò):72002;

  5.須保證mchid之前沒(méi)有被其他appid設(shè)置過(guò),否則報(bào)錯(cuò)72004;

  6.單次僅限設(shè)置100個(gè)mchid,若超過(guò)100個(gè)請(qǐng)多次調(diào)用本接口。

8.4.2 刪除支付即會(huì)員規(guī)則接口

  刪除之前已經(jīng)設(shè)置的支付即會(huì)員規(guī)則。

接口說(shuō)明

    支持商戶設(shè)置支付即會(huì)員的規(guī)則,可以區(qū)分時(shí)間段和金額區(qū)間發(fā)會(huì)員卡。

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

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

參數(shù)說(shuō)明

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

POST數(shù)據(jù)

{
    "card_id": "xxxxxxxxa",
    "mchid_list": [
        123,
        1234,
        12345
    ]
}

字段說(shuō)明

字段名            說(shuō)明            
card_id            卡券ID。            
mchid_list            本次刪除的支付即會(huì)員的商戶號(hào)列表            

返回?cái)?shù)據(jù)說(shuō)明

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

{
    "errcode": 0,
    "errmsg": "ok",
    "succ_list":[
        {
            "mchid": "xxxxx",
            "errcode": 0,
            "errmsg": "ok",
            "occupy_appid": "wxxxxxxxxxxx"
        },
        {
            "mchid": "xxxxx",
            "errcode": 0,
            "errmsg": "ok",
            "occupy_appid": "wxxxxxxxxxxx"
        }
    ],
    "fail_list":[
        {
            "mchid": "xxxxx",
            "errcode": 0,
            "errmsg": "ok",
            "occupy_appid": "wxxxxxxxxxxx"
        },
        {
            "mchid": "xxxxx",
            "errcode": 0,
            "errmsg": "ok",
            "occupy_appid": "wxxxxxxxxxxx"
        }
    ]
}
參數(shù)名            描述            
errcode            錯(cuò)誤碼,0為正常。            
errmsg            錯(cuò)誤信息。            
succ_list            設(shè)置成功的mchid列表            
fail_list            設(shè)置失敗的mchid列表            
mchid            支付的商戶號(hào)            
occupy_appid            設(shè)置失敗原因?yàn)橹貜?fù)設(shè)置時(shí),該mchid當(dāng)前被占用的appid,商戶須使用該appid解除綁定后重新設(shè)置。

           

8.4.3 查詢商戶號(hào)支付即會(huì)員規(guī)則接口

接口說(shuō)明

    可以查詢某個(gè)商戶號(hào)是否支持支付即會(huì)員功能

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

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

參數(shù)說(shuō)明

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

POST數(shù)據(jù)

{"mchid":"xxxxxxxx"}

字段說(shuō)明

字段名            說(shuō)明            
mchid            要查詢的支付商戶號(hào)。            

返回?cái)?shù)據(jù)說(shuō)明

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

{
    "errcode": 0,
    "errmsg": ok,
    "card_id": "xxxxxxxxxxxxxxxxxx",
    "occupy_appid": "wxxxxxxxxxxx",
    "is_locked": true
}

8.5 設(shè)置會(huì)員卡拉出微信支付刷卡界面

通過(guò)接口創(chuàng)建支持刷卡類型的會(huì)員卡,用戶點(diǎn)擊快速買單后即可拉出刷卡界面進(jìn)行支付。以下為示意圖:

微信支付刷卡界面

8.5.1 創(chuàng)建會(huì)員卡支持微信支付刷卡

 商戶可以創(chuàng)建一張會(huì)員卡支持微信支付刷卡,須在創(chuàng)建會(huì)員卡接口的JSON中加入以下字段:

{
     "card": {
         "card_type": "MEMBER_CARD",
         "member_card": {
             "base_info": {
                 "pay_info":
                 {
                         "swipe_card":
                         {
                 
                            "is_swipe_card":true
                         }
                        }
                      }
         }
     }
 }

8.5.2 更新會(huì)員卡支持微信支付刷卡

商戶可以更新已有會(huì)員卡支持微信支付刷卡,須在更新會(huì)員卡接口的JSON中加入以下字段:

{
    "card_id": "ph_gmt7cUVrlRk8swPwx7aDyF-pg",
    "member_card": {
             "base_info": {
                 "pay_info":
                 {
                         "swipe_card":
                         {
                 
                            "is_swipe_card":true
                         }
                        }
                      }
     }
 }


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

掃描二維碼

下載編程獅App

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

編程獅公眾號(hào)