小程序发券插件

1{
2  "plugins": {
3    "sendCoupon": {
4      "version": "latest",
5      "provider": "wxf3f436ba9bd4be7b"
6    }
7  }
8}

1{
2  "usingComponents": {
3    "send-coupon": "plugin://sendCoupon/send-coupon"
4  }
5}

1//page.wxml
2<send-coupon
3    bind:sendcoupon="getcoupon"
4    bind:userconfirm="redirectuser"
5    send_coupon_params="{{send_coupon_params}}"
6    sign="{{sign}}"
7    send_coupon_merchant="{{send_coupon_merchant}}"
8    suggest_immediate_use="{{suggest_immediate_use}}"
9  >
10    <!-- 内部为自定义代码，按钮点击部分的代码写在这里 -->
11    <!-- [[以下为示例代码 -->
12    <view class="text">领券</view>
13    <!-- 以上为示例代码 ]] -->
14  </send-coupon>

bind:sendcoupon / bindsendcoupon【原接口为bindcustomevent，建议更新原接口名称】选填 string

插件在用户点击后成功获取到优惠券信息触发的事件函数名称，使用方法可参考《自定义组件文档》的自定义组件触发事件
注意：查询到优惠券信息不代表用户一定能够看到优惠券弹窗或者发券成功，如果参数send_coupon_result中没有券发送成功（券状态码不为SUCCESS），用户会被告知领券失败

bind:userconfirm / binduserconfirm 选填 string

用户点击弹窗中的确认收券按钮后触发的事件函数名称，可用作跳转到优惠券的使用界面

suggest_immediate_use 选填 boolean

提示优惠券是否要立即使用，如果为true，弹窗中的确认按钮内的文字为“立即使用”，如果为false，则显示为“我知道了”，参数默认值为false
注意：此参数对用户是否立即使用没有约束力，需要商家在用户确认领券事件内自行约束。如果此参数设为true，请在binduserconfirm事件中引导用户使用优惠券

send_coupon_params 必填 array

发券参数，一次最多10张

数组

stock_id 必填 string(20) 微信支付券批次ID out_request_no 必填 string(64) 发券凭证，可包含英文字母，数字，｜，_，*，-等内容，不允许出现其他不合法符号，需在单个批次单个用户下确保唯一性 coupon_code 选填 string(128) 券code，如果是商家券，且批次是发放时指定code的类型，则发券时必填coupon_code；支付券无需填写。 create_coupon_merchant 选填 string(15) 创建支付券的商户号；如果是支付券，则是必填项；商家券无需填写 customize_send_time{n} 选填 string(32) 商家券在商户业务系统里的实际领取时间，仅针对有设置相对领取时间的批次生效（即批次有设置“生效后N天内有效”或“领取后N天开始生效”时间字段）。传入后，将使用传入的时间点，做为商家券领取时间来计算有效期，而非用户在微信支付系统中点击领取的时间 。

sign 必填 string(64)

签名计算值。
签名方式：HMAC-SHA256。
签名规则：详见《V2 签名规则》
参与签名字段说明

send_coupon_merchant 必填 string(15)

发券商户号

send_coupon_merchant 必填 string(15)

发券商户号

stock_id{n} 必填 string(20)

微信支付券批次ID，{n}为下标，从0开始，例如stock_id0

out_request_no{n} 必填 string(64)

发券凭证，{n}为下标，从0开始，例如out_request_no0。可包含英文字母，数字，｜，_，*，-等内容，不允许出现其他不合法符号，需在单个批次单个用户下确保唯一性

coupon_code{n} 选填 string(128)

券code，如果批次是发放时指定code的类型，则发券时必填coupon_code{n}为下标，从0开始，例如stock_id0

customize_send_time 选填 string(32)

商家券在商户业务系统里的实际领取时间，仅针对有设置相对领取时间的批次生效（即批次有设置“生效后N天内有效”或“领取后N天开始生效”时间字段）。传入后，将使用传入的时间点，做为商家券领取时间来计算有效期，而非用户在微信支付系统中点击领取的时间 。
遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.+08:00表示，北京时间2015年5月20日 13点29分35秒。
目前只支持商家券、支付券暂不支持

create_coupon_merchant{n} 选填 string(15)

创建支付券的商户号； {n}为下标，从0开始，例如create_coupon_merchant0。 如果是支付券，则是必填项； 商家券无需填写

1javascript
2//page.js
3Page({
4  // 此函数名称可以自定义，跟bindcustomevent绑定的保持一致
5  getcoupon: function(params) {
6    // 插件返回信息在params.detail
7    console.log('getcoupon', params)
8  }
9})

如果事件绑定正确，在用户点击领券后，会触发领券事件，得到返回之后会调用getcoupon函数。

从回调函数参数detail中，获取参数。

errcode 必填 string（32）

返回整体错误码

---

msg 必填 string(128)

返回整体错误信息

---

send_coupon_result 必填 object

发券结果，包含需要发放的每张券的结果信息，是否成功或失败原因

	属性
	code 必填 string(16) 单张券错误码 message 必填 string(128) 单张券错误信息 stock_id 必填 string(20) 微信支付券批次ID coupon_code 必填 string(128) 券的唯一标识 out_request_no 必填 string(64) 发券凭证，可包含英文字母，数字，｜，_，*，-等内容，不允许出现其他不合法符号，需在单个批次单个用户下确保唯一性

 

返回示例

1javascript
2//获取代码示例
3Page({
4  data: {
5    // ...
6  },
7  onLoad: function() {
8    // ...
9  },
10  getcoupon: function(params) {
11    console.log('getcoupon', params)
12    console.log('detail', params.detail)
13  }
14})