最新更新時間:2020.08.17 版本說明
商戶在已有小程序場景內(nèi),向指定用戶發(fā)放指定批次的支付券(當(dāng)前僅支持商家券,暫不支持微信支付代金券)
插件版本號:1.1.5(更新時間 2020/8/17)
版本號將用在小程序配置app.json 文件配置中, "version": "1.1.5"
在小程序配置app.json 文件中加入如下配置:
// app.json
{
"plugins": {
"sendCoupon": {
"version": "1.1.5",
"provider": "wxf3f436ba9bd4be7b"
}
}
}
注意:插件本身不帶任何樣式,只用于發(fā)起請求,支持插入子節(jié)點,子節(jié)點供商戶任意定義樣式和內(nèi)容。
1)在小程序頁面配置文件中加入如下配置,引入send-coupon組件:
// page.json
{
"usingComponents": {
"send-coupon": "plugin://sendCoupon/send-coupon"
}
}
2)在小程序頁面的WXML模板中加入如下代碼,并填入相關(guān)字段,字段說明參見小程序發(fā)券插件字段說明表
//page.wxml
<send-coupon
bindcustomevent="getcoupon"
send_coupon_params="{{send_coupon_params}}"
sign="{{sign}}"
send_coupon_merchant="{{send_coupon_merchant}}"
>
<!-- 內(nèi)部為自定義代碼,按鈕點擊部分的代碼寫在這里 -->
<!-- [[以下為示例代碼 -->
<view class="text">領(lǐng)取</view>
<!-- 以上為示例代碼 ]] -->
</send-coupon>
javascript
//page.js
Page({
// 此函數(shù)名稱可以自定義,跟bindcustomevent綁定的保持一致
getcoupon: function(params) {
// 插件返回信息在params.detail
console.log('getcoupon', params)
}
})
如果事件綁定正確,在用戶點擊領(lǐng)券后,會觸發(fā)領(lǐng)券事件,得到返回之后會調(diào)用getcoupon函數(shù)。
從回調(diào)函數(shù)參數(shù)detail中,獲取參數(shù)。
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
外層錯誤碼 | errcode | string |
是 | 返回整體錯誤碼 |
錯誤信息 | msg | string |
是 | 返回整體錯誤信息 |
+發(fā)券結(jié)果 | send_coupon_result | object | 是 | 發(fā)券結(jié)果,包含需要發(fā)放的每張券的結(jié)果信息,是否成功或失敗原因 |
javascript
//獲取代碼示例
Page({
data: {
// ...
},
onLoad: function() {
// ...
},
getcoupon: function(params) {
console.log('getcoupon', params)
console.log('detail', params.detail)
}
})
Detail中errcode返回錯誤碼
錯誤碼 | 描述 | 解決方案 |
---|---|---|
OK | 調(diào)用成功 | 接口調(diào)用成功,具體發(fā)券結(jié)果(是否發(fā)券成功)需查看發(fā)券結(jié)果(send_coupon_result)中的參數(shù) |
PARAM_ERROR | 參數(shù)錯誤 | 參數(shù)錯誤,請開發(fā)者查看msg中具體的錯誤信息并進行修復(fù)處理 |
USER_NOT_EXISTS | 登錄態(tài)獲取失效 | 引導(dǎo)用戶重試 |
USER_GET_FAILED | 登錄態(tài)獲取失敗 | 報錯,提示用戶稍后操作 |
SIGN_ERROR | 簽名錯誤 | 請開發(fā)者檢查簽名正確性 |
SYSTEMERROR | 發(fā)券超時 | 提示報錯,提示用戶稍后操作 |
FREQUENCY_LIMITED | 發(fā)券頻率過高 | 提示報錯,引導(dǎo)用戶稍后操作。例如“活動太過火爆,請稍后再領(lǐng)取” |
發(fā)券結(jié)果(send_coupon_result)中的錯誤碼
錯誤碼 | 描述 | 解決方案 |
---|---|---|
SUCCESS | 該張券發(fā)券成功 | 提示用戶領(lǐng)取成功/改變前端領(lǐng)券按鈕狀態(tài) |
FAILED | 該張券發(fā)券失敗,查看message中的具體錯誤信息 | 提示用戶領(lǐng)券失敗,請開發(fā)者查看message中具體的錯誤信息并進行修復(fù)處理 |
NOTENOUGH | 總預(yù)算用完 | 提示用戶領(lǐng)券失敗,請增加批次預(yù)算 |
DAYLIMIT | 用戶達(dá)到單天限領(lǐng) | 提示用戶領(lǐng)券失敗,如需繼續(xù)發(fā)放,可調(diào)整該批次單天發(fā)放上限 |
NATURELIMIT | 用戶自然人限領(lǐng) | 提示用戶領(lǐng)券失敗,可提示用戶檢查其所有微信號領(lǐng)券情況,并請商戶留意刷單風(fēng)險 |
MAXQUOTA | 用戶領(lǐng)取張數(shù)達(dá)到上限 | 提示用戶領(lǐng)券失敗,該用戶領(lǐng)取數(shù)量已達(dá)上限 |
DUPREQUEST | 已通過該發(fā)券憑證給用戶發(fā)券 | 提示用戶領(lǐng)取成功/改變前端領(lǐng)券按鈕狀態(tài) |
NOTRUNNING | 批次狀態(tài)非運營中 | 提示用戶領(lǐng)券失敗,并檢查批次狀態(tài)
|
EXPIRED | 該批次已過期 | 請更換在有效期內(nèi)的批次,再進行發(fā)放 |