朋友的券-投放朋友的券


上一篇 : 朋友的券-配置库存、充值券点 下一篇: 朋友的券-朋友的券核销



朋友的券投放

该部分介绍朋友的券投放方式、接口以及具体操作。

1接口说明

该部分主要讲述微信卡券不同的投放渠道和投放方式,建议开发者仔细阅读本部分文档,避免在投放过程中出现消费者无法共享的情况。

2开发者注意事项

共享券投放与普通券投放略有不同。现共享券仅支持线下二维码扫码投放(不包含长按二维码识别)、摇一摇Beacon投放的H5以及WIFI环境H5投放场景,共享券同时支持扫码跳转H5后领券,其他投放渠道暂不支持

3案例介绍

3.1卡券二维码投放

3.1.1场景介绍

二维码一般用于商户卡券的店内投放、海报投放和传单投放,商户通过接口生成二维码之后,可以将二维码贴在收银台、海报、传单等宣传物料上。用户扫码后可以将卡券共享至共享券列表,供自己和朋友们使用。

3.1.2使用流程

0.jpg

完成以上流程,开发者需要:

1.创建朋友的券并再通过审核之后在【微信公众平台商户后台】增加库存;

2.调用创建二维码接口生成领券二维码;

3.监听领取时间推送,记录卡券发放量并做数据统计。

3.1.3API列表

步骤 API名称 用途 API属性
1 生成二维码接口 创建二维码得到二维码的展示url 投放接口
2 卡券领取事件推送 用户领取卡券后,获得用户的openid、code和card_id等信息 事件推送

3.2H5网页投放

3.2.1场景介绍

开发者可以开发领券H5网页,并将url转化成二维码或者配置在微信摇一摇或者微信Wi-Fi投放。 该渠道适用于对领取页面有要求的商户,可以自定义页面样式体现品牌价值或者自定义领取流程(如加入游戏环节)等。

注意:

1.目前仅支持线下场景投放,如卡券二维码、从扫码进入H5网页扫码或者从Wi-Fi或者iBeacon进入的网页领券。其他渠道暂不支持。

2.点击此处了解Wi-Fi和微信摇一摇摇一摇周边(iBeacon)

3.2.2接口调用流程

0.png

3.2.3API列表

步骤 API名称 用途 API属性
1 获取JSAPI_TICKET接口 获取到JSAPI_TICKET用于参与JS SDK config 基础接口
2 获取卡券API_TICKET接口 获取到卡券API_TICKET用于cardext内signarue签名 投放接口
3 批量添加卡券接口 将共享券添加到用户的券列表 投放接口
4 卡券领取事件推送 用户领取卡券后,获得用户的openid、code和card_id等信息 事件推送

4API详情

4.1设置测试白名单接口

当朋友的券审核未通过时,开发者可以通过设置白名单的方式领取朋友的券并共享。 共享的未审核状态的券仅白名单列表内可见,详情请见:<a href="http://mp.weixin.qq.com/advanced/wiki?t=t=resource/res_main&id=mp1451025062&anchor=6 target="_blank">设置测试白名单接口

4.2生成二维码接口

接口调用请求说明


http请求方式: POST https://api.weixin.qq.com/card/qrcode/create?access_token=TOKEN

参数说明

参数 是否必须 说明
POST数据 JSON数据
access_token 调用接口凭证

POST数据

开发者可以设置扫描二维码领取单张卡券,此时POST数据为:


{

   "action_name": "QR_CARD",

   "expire_seconds": 1800,

   "action_info": {

       "card": {

           "card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",

           "code": "198374613512",

           "openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",

           "is_unique_code": false,

           "outer_id": 1

       }

   }}
参数名 必填 类型 示例值 描述
code string(20) 110201201245 卡券Code码,use_custom_code字段为true的卡券必须填写,非自定义code不必填写。。
card_id string(32) pFS7Fjg8kV1IdDz01r4SQwMkuCKc 卡券ID。
openid string(32) oXch-jkrxp42VQu8ldweCwDt97qo 指定领取者的openid,只有该用户能领取。bind_openid字段为true的卡券必须填写,非指定openid不必填写。
expire_seconds unsigned int 60 指定二维码的有效时间,范围是60 ~ 1800秒。不填默认为永久有效。
is_unique_code bool false 指定下发二维码,生成的二维码随机分配一个code,领取后不可再次扫描。填写true或false。默认false。
outer_id int 12 领取场景值,用于领取渠道的数据统计,默认值为0,字段类型为整型,长度限制为60位数字。用户领取卡券后触发的 事件推送 中会带上此自定义场景值。

注意事项:

1.若开发者填写了is_unique_code为true,需要保证卡券已审核通过并有库存,否则会报错。

返回数据

数据示例:


{

   "errcode": 0,

   "errmsg": "ok",

   "ticket": "gQHB8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0JIV3lhX3psZmlvSDZmWGVMMTZvAAIEsNnKVQMEIAMAAA==",

   "expire_seconds": 1800,

   "url": "http://weixin.qq.com/q/BHWya_zlfioH6fXeL16o",

   "show_qrcode_url": " https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQH98DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0czVzRlSWpsamlyM2plWTNKVktvAAIE6SfgVQMEgDPhAQ%3D%3D"

}
参数名 描述
errcode 错误码
errmsg 错误信息
ticket 获取的二维码ticket,凭借此ticket调用 通过ticket换取二维码接口 可以在有效时间内换取二维码。
url 二维码图片解析后的地址,开发者可根据该地址自行生成需要的二维码图片
show_qrcode_url 二维码显示地址,点击后跳转二维码页面

4.3获取JSAPI_TICKET接口

接口调用请求说明


http请求方式: GET https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi

返回数据


{
   "errcode": 0,
   "errmsg": "ok",
   "ticket": "bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
   "expires_in": 7200
}
参数名 描述
errcode 错误码
errmsg 错误信息
ticket 获取的JSAPI_TICKET
expires_in 有效时间,ticket有效时间为2小时,2小时内不变

4.4获取卡券API_TICKET接口

接口调用请求说明


http请求方式: GET https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=wx_card

返回数据


{
   "errcode": 0,
   "errmsg": "ok",
   "ticket": "bxLdikRXVbTPdHSM05e5u5sUoXNKdvsdshFKA",
   "expires_in": 7200
}
参数名 描述
errcode 错误码
errmsg 错误信息
ticket 获取的卡券API_TICKET
expires_in 有效时间,ticket有效时间为2小时,2小时内不变

4.5批量添加卡券(addcard)接口

朋友的券领取须指引用户升级到最新的微信客户端版本,最低版本要求为:iOS微信版本为6.3.6及以上,Android微信版本为6.3.7及以上。 开发者可以判断用户版本后调用addcard接口,请点击查看判断用户客户端版本批量添加卡券接口

4.6卡券领取事件

用户领取朋友的券后,会有事件推送到开发者服务器。 点击查看卡券事件推送机制

5帮助

5.1错误码

错误码 说明 排错指引
40053 JSON结构错误 card_id或者参数名有误,请对比示例排查
43008 当前账号未开通支付权限或未开通支付后送券接口权限,无法设置支付后送朋友的券功能 前往开通 微信支付
45021 赠券规则列表长度高于10个 减少赠券规则列表的个数
47001 创建JSON结构错误 针对报错信息提示的位置对比示例排查

5.2常见问题

1.如何区分领取渠道?

开发者可以在生成二维码或者H5添加卡券时,填入outer_id(自定义渠道值),这个数值会随领取事件推送至开发者服务器,从而使得开发者可以区分每一个code(卡券串码)的投放渠道。

2.为什么长按二维码不能领取卡券?

目前朋友的券仅支持线下渠道投放,对于线上的场景(如长按二维码领取、公众号群发)等做了限制。


上一篇 : 朋友的券-配置库存、充值券点 下一篇: 朋友的券-朋友的券核销