更新日志
版本号 | 更新内容 | 更新时间 |
---|---|---|
V1.1 |
1.新增卡券货架创建接口,支持开发者调用接口创建卡券货架进行卡券投放 2. 新增导入code接口,支持自定义code开发者通过导入code通过群发、客服等渠道 派发卡券 |
2015-8-12 |
V1.2 | 新增扫描二维码批量领取接口,用户扫描二维码可以同时领取多张卡券 | 2015-8-31 |
事件推送中会带上此自定义场景值。
outer_str
否
string(128)
13b
outer_id字段升级版本,字符串类型,用户首次领卡时,会通过领取事件推送给商户;
对于会员卡的二维码,用户每次扫码打开会员卡后点击任何url,会将该值拼入url中,方便开发者定位扫码来源
返回数据
{
"errcode": 0,
"errmsg": "ok",
"ticket": "gQHB8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0JIV3lhX3psZmlvSDZmWGVMMTZvAAIEsNnKVQMEIAMAAA==",//获取ticket后需调用换取二维码接口获取二维码图片,详情见字段说明。
"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
二维码显示地址,点击后跳转二维码页面
注意事项:
1.自定义code的卡券,生成的二维码每次只能领取一次,若开发者想要使用自己的串码系统并且想要用微信的二维码
投放,须先将自定义code导入;
2.领取多张的二维码一次最多填入5个card_id,否则报错。
上传图文素材接口中content字段,即可获取嵌入卡券的图文消息素材。
特别注意:目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
接口调用请求说明
HTTP请求方式: POST
URL:https://api.weixin.qq.com/card/mpnews/gethtml?access_token=TOKEN
参数说明
参数
是否必须
说明
POST数据
是
Json数据
access_token
是
调用接口凭证
POST数据
{
"card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI"
}
参数名
必填
类型
示例值
描述
card_id
否
string(32)
pFS7Fjg8kV1IdDz01r4SQwMkuCKc
卡券ID。
返回数据
{
"errcode":0,
"errmsg":"ok",
"content":"<iframeclass=\"res_iframecard_iframejs_editor_card\"data-src=\"http: \/\/mp.weixin.qq.com\/bizmall\/appmsgcard?action=show&biz=MjM5OTAwODk4MA%3D%3D&cardid=p1Pj9jnXTLf2nF7lccYScFUYqJ0&wechat_card_js=1#wechat_redirect\">"
}
参数名
描述
errcode
错误码
errmsg
错误信息
content
返回一段html代码,可以直接嵌入到图文消息的正文里。即可以把这段代码嵌入到上传图文消息素材接口中的content字段里。
根据分组进行群发接口
目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
根据OpenID列表群发接口
目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
客服接口-发消息
目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
预览接口
领取事件中,推送至开发者服务器。
示例: 在二维码投放方式中设置outer_str为12b
{
"action_name": "QR_CARD",
"action_info": {
"card": {
"card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"code": "198374613512",
"openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"expire_seconds": "1800",
"is_unique_code": false ,
"outer_str" : "12b"
}
}
}
领取事件XML文件
<xml> <ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[FromUser]]></FromUserName>
<FriendUserName><![CDATA[FriendUser]]></FriendUserName>
<CreateTime>123456789</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[user_get_card]]></Event>
<CardId><![CDATA[cardid]]></CardId>
<IsGiveByFriend>1</IsGiveByFriend>
<UserCardCode><![CDATA[12312312]]></UserCardCode>
<OuterStr>12b</OuterStr>
</xml>
6 设置测试白名单
接口说明
由于卡券有审核要求,为方便公众号调试,可以设置一些测试帐号,这些帐号可领取未通过审核的卡券,体验整个流程。
开发者注意事项
1.同时支持“openid”、“username”两种字段设置白名单,总数上限为10个。
2.设置测试白名单接口为全量设置,即测试名单发生变化时需调用该接口重新传入所有测试人员的ID.
3.白名单用户领取该卡券时将无视卡券失效状态,请开发者注意。
接口调用请求说明
HTTP请求方式: POST
URL:https://api.weixin.qq.com/card/testwhitelist/set?access_token=TOKEN
参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
Json数据
POST数据
{
"openid": [
"o1Pj9jmZvwSyyyyyyBa4aULW2mA",
"o1Pj9jmZvxxxxxxxxxULW2mA"
],
"username": [
"afdvvf",
"abcd"
]
}
参数说明
参数名
必填
类型
示例值
描述
openid
否
string(20)
o1Pj9jmZvwSyyyyyyBa4aULW2mA
测试的openid列表。
username
否
string(32)
eddy
测试的微信号列表。
返回说明
{
"errcode":0,
"errmsg":"ok"
}
参数名
描述
errcode
错误码,0为正常。
errmsg
错误信息。
outer_str
outer_id字段升级版本,字符串类型,用户首次领卡时,会通过领取事件推送给商户;
对于会员卡的二维码,用户每次扫码打开会员卡后点击任何url,会将该值拼入url中,方便开发者定位扫码来源
特别注意:目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
接口调用请求说明
HTTP请求方式: POST
URL:https://api.weixin.qq.com/card/mpnews/gethtml?access_token=TOKEN
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
POST数据 | 是 | Json数据 |
access_token | 是 | 调用接口凭证 |
POST数据
{
"card_id":"p1Pj9jr90_SQRaVqYI239Ka1erkI"
}
参数名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
card_id | 否 | string(32) | pFS7Fjg8kV1IdDz01r4SQwMkuCKc | 卡券ID。 |
返回数据
{
"errcode":0,
"errmsg":"ok",
"content":"<iframeclass=\"res_iframecard_iframejs_editor_card\"data-src=\"http: \/\/mp.weixin.qq.com\/bizmall\/appmsgcard?action=show&biz=MjM5OTAwODk4MA%3D%3D&cardid=p1Pj9jnXTLf2nF7lccYScFUYqJ0&wechat_card_js=1#wechat_redirect\">"
}
参数名 | 描述 |
---|---|
errcode | 错误码 |
errmsg | 错误信息 |
content | 返回一段html代码,可以直接嵌入到图文消息的正文里。即可以把这段代码嵌入到上传图文消息素材接口中的content字段里。 |
根据分组进行群发接口
目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
根据OpenID列表群发接口
目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
客服接口-发消息
目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。
预览接口
领取事件中,推送至开发者服务器。
示例: 在二维码投放方式中设置outer_str为12b
{
"action_name": "QR_CARD",
"action_info": {
"card": {
"card_id": "pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
"code": "198374613512",
"openid": "oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
"expire_seconds": "1800",
"is_unique_code": false ,
"outer_str" : "12b"
}
}
}
领取事件XML文件
<xml> <ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[FromUser]]></FromUserName>
<FriendUserName><![CDATA[FriendUser]]></FriendUserName>
<CreateTime>123456789</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[user_get_card]]></Event>
<CardId><![CDATA[cardid]]></CardId>
<IsGiveByFriend>1</IsGiveByFriend>
<UserCardCode><![CDATA[12312312]]></UserCardCode>
<OuterStr>12b</OuterStr>
</xml>
6 设置测试白名单
接口说明
由于卡券有审核要求,为方便公众号调试,可以设置一些测试帐号,这些帐号可领取未通过审核的卡券,体验整个流程。
开发者注意事项
1.同时支持“openid”、“username”两种字段设置白名单,总数上限为10个。
2.设置测试白名单接口为全量设置,即测试名单发生变化时需调用该接口重新传入所有测试人员的ID.
3.白名单用户领取该卡券时将无视卡券失效状态,请开发者注意。
接口调用请求说明
HTTP请求方式: POST
URL:https://api.weixin.qq.com/card/testwhitelist/set?access_token=TOKEN
参数说明
参数
是否必须
说明
access_token
是
调用接口凭证
POST数据
是
Json数据
POST数据
{
"openid": [
"o1Pj9jmZvwSyyyyyyBa4aULW2mA",
"o1Pj9jmZvxxxxxxxxxULW2mA"
],
"username": [
"afdvvf",
"abcd"
]
}
参数说明
参数名
必填
类型
示例值
描述
openid
否
string(20)
o1Pj9jmZvwSyyyyyyBa4aULW2mA
测试的openid列表。
username
否
string(32)
eddy
测试的微信号列表。
返回说明
{
"errcode":0,
"errmsg":"ok"
}
参数名
描述
errcode
错误码,0为正常。
errmsg
错误信息。
目前该接口仅支持填入非自定义code的卡券,自定义code的卡券需先进行code导入后调用。