微信小程序API卡券,微信小程序批量添加卡券
2017-12-21
導讀:wx.addCard(OBJECT) 基礎庫版本 1.1.0 開始支持,低版本需做兼容處理 批量添加卡券。 Object參數(shù)說明: 參數(shù) 類型 必填 說明 cardList ObjectArray 是 需要添加的卡券列表,列表內(nèi)對象說明請參見請...
wx.addCard(OBJECT)
基礎庫版本 1.1.0 開始支持,低版本需做兼容處理
批量添加卡券。
Object參數(shù)說明:
參數(shù) | 類型 | 必填 | 說明 |
---|---|---|---|
cardList | ObjectArray | 是 | 需要添加的卡券列表,列表內(nèi)對象說明請參見請求對象說明 |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行) |
請求對象說明
參數(shù) | 類型 | 說明 |
---|---|---|
cardId | String | 卡券 Id |
cardExt | String | 卡券的擴展參數(shù) |
cardExt 說明
參數(shù) | 類型 | 必填 | 是否參與簽名 | 說明 |
---|---|---|---|---|
code | String | 否 | 是 | 用戶領取的 code,僅自定義 code 模式的卡券須填寫,非自定義 code 模式卡券不可填寫,詳情 |
openid | String | 否 | 是 | 指定領取者的openid,只有該用戶能領取。 bind_openid 字段為 true 的卡券必須填寫,bind_openid 字段為 false 不可填寫。 |
timestamp | Number | 是 | 是 | 時間戳,東八區(qū)時間,UTC+8,單位為秒 |
nonce_str | String | 否 | 是 | 隨機字符串,由開發(fā)者設置傳入,加強安全性(若不填寫可能被重放請求)。隨機字符串,不長于 32 位。推薦使用大小寫字母和數(shù)字,不同添加請求的 nonce_str 須動態(tài)生成,若重復將會導致領取失敗。 |
fixed_begintimestamp | Number | 否 | 否 | 卡券在第三方系統(tǒng)的實際領取時間,為東八區(qū)時間戳(UTC+8,精確到秒)。當卡券的有效期類為 DATE_TYPE_FIX_TERM 時專用,標識卡券的實際生效時間,用于解決商戶系統(tǒng)內(nèi)起始時間和領取微信卡券時間不同步的問題。 |
outer_str | String | 否 | 否 | 領取渠道參數(shù),用于標識本次領取的渠道值。 |
signature | String | 是 | - | 簽名,商戶將接口列表中的參數(shù)按照指定方式進行簽名,簽名方式使用 SHA1,具體簽名方案參見:卡券簽名 |
注:cardExt 需進行 JSON 序列化為字符串傳入
回調(diào)結(jié)果:
回調(diào)類型 | errMsg | 說明 |
---|---|---|
success | addCard:ok | 添加卡券成功 |
fail | addCard:fail cancel | 用戶取消添加卡券 |
fail | addCard:fail (detail message) | 添加卡券失敗,其中 detail message 為后臺返回的詳細失敗原因 |
success返回參數(shù):
參數(shù) | 類型 | 說明 |
---|---|---|
cardList | ObjectArray | 卡券添加結(jié)果列表,列表內(nèi)對象說明請詳見返回對象說明 |
返回對象說明
參數(shù) | 類型 | 說明 |
---|---|---|
code | String | 加密 code,為用戶領取到卡券的code加密后的字符串,解密請參照:code 解碼接口 |
cardId | String | 用戶領取到卡券的Id |
cardExt | String | 用戶領取到卡券的擴展參數(shù),與調(diào)用時傳入的參數(shù)相同 |
isSuccess | Boolean | 是否成功 |
示例代碼:
wx.addCard({
cardList: [
{
cardId: '',
cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
}, {
cardId: '',
cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
}
],
success: function(res) {
console.log(res.cardList) // 卡券添加結(jié)果
}
})
wx.openCard(OBJECT)
基礎庫版本 1.1.0 開始支持,低版本需做兼容處理
查看微信卡包中的卡券。
Object參數(shù)說明:
參數(shù) | 類型 | 必填 | 說明 |
---|---|---|---|
cardList | ObjectArray | 是 | 需要打開的卡券列表,列表內(nèi)參數(shù)詳見openCard 請求對象說明 |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行) |
openCard 請求對象說明
參數(shù) | 類型 | 說明 |
---|---|---|
cardId | String | 需要打開的卡券 Id |
code | String | 由 addCard 的返回對象中的加密 code 通過解密后得到,解密請參照:code 解碼接口 |
示例代碼:
wx.openCard({
cardList: [
{
cardId: '',
code: ''
}, {
cardId: '',
code: ''
}
],
success: function(res) {
}
})
Tip
-
tip
: 目前只有認證小程序才能使用卡券接口,可參考指引進行認證。 -
tip
: 了解更多信息,請查看微信卡券接口文檔
更多微信小程序開發(fā)教程,可以關(guān)注hi小程序。
第二部分:如何開通一個小商店