一、获取微信红包封面
接口应在服务器端调用，详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090（最新稳定版下载），wx-server-sdk>=0.4.0
接口说明
接口英文名
getRedPacketCoverUrl
功能描述
本接口用于获得指定用户可以领取的红包封面链接。获取参数ctoken参考微信红包封面开放平台。
调用方式
HTTPS 调用
POST https://api.weixin.qq.com/redpacketcover/wxapp/cover_url/get_by_token?access_token=ACCESS_TOKEN
云调用
-
出入参和HTTPS调用相同，调用方式可查看云调用说明文档
-
接口方法为: openapi.redpacketcover.getAuthenticationUrl
第三方调用
-
调用方式以及出入参和HTTPS相同，仅是调用的token不同
-
该接口所属的权限集id为：112
-
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用
请求参数
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token |
| openid | string | 是 | 可领取用户的openid |
| ctoken | string | 是 | 在红包封面平台获取发放ctoken（需要指定可以发放的appid） |
返回参数
| 属性 | 类型 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| errcode | number | 错误码 | |||||||||
| errmsg | string | 错误描述 | |||||||||
| data | object | 指定用户可以领取的链接（带鉴权的链接） | |||||||||
|
|||||||||||
调用示例
示例说明: HTTPS请求示例
请求数据示例
{
"openid":"xxxxxxxxxxmTo5lAUQxxxxxxxxxx",
"ctoken":"xxxxxqpHPu1xxxxx"
}
返回数据示例
{
"data" : {
"url" : "https://xxx.xxx.xxx.xxx/xxx"
},
"errcode" : 0,
"errmsg" : "success"
}
错误码
| 错误码 | 错误码取值 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 9600001 | 参数缺失 openid | |
| 9600002 | 参数缺失 ctoken | |
| 9600003 | 系统错误 | |
| 9600004 | ctoken 错误 | |
| 9600005 | openid 错误 | |
| 9600006 | 小程序不在配置列表中 | |
| 9600007 | 小程序与openid不对应 |
二、发放封面
发放封面
购买封面成功后，即可发放封面给指定用户。需注意，红包封面自购买成功后，6个月内发放有效，过期后用户将无法领取。请在发放有效期内尽快发放封面。
发放方式
发放方式包括领取二维码、领取序列号、领取链接，定制方可根据活动场景、用户群体、领取规则等选择合适的发放方式。
裂变发放
当选择发放物料为可多人领取时，也可同时选择裂变发放。
设置后，封面还可以通过同款红包中展示的「领取此封面」入口发放。封面可以持续裂变，直到本次发放数量消耗完。（例：用户A使用该封面发红包时，可将封面裂变给用户B/C等。用户B/C领取后，可在发红包时将同款封面裂变给更多用户。）
领取二维码
用户可在线下扫码或线上长按图片识别码领取红包封面。对于线下的场景，需要定制方有印刷二维码物料的能力。
领取序列号
用户需更新手机微信至最新版本，打开发红包界面，前往“红包封面”-“添加红包封面”。输入有效的领取序列号即可领取红包封面。
领取链接
用户需在微信内打开领取链接，才能领取红包封面。领取链接是最通用的发放方式，定制方可将领取链接配置在小程序、公众号文章、H5链接中。
领取方式
为限制上述领取二维码/领取序列号/领取链接的领取范围，平台提供两种领取方式：一人领取、多人领取。
一人领取
每个领取二维码/领取序列号/领取链接，只能被一个微信用户领取。领取后，其他用户将无法领取。
多人领取
每个领取二维码/领取序列号/领取链接，可以被多个微信用户领取。定制方可以设置领取人数上限，领取人数超过上限后，其他用户将无法领取。
发放上限
封面单次发放数量存在上限，当超过单次上限时，可以分多次发放。
- 领取二维码：一人领取时单次发放上限为2万个，多人领取时单次发放上限为100万个。
- 领取序列号：一人领取时单次发放上限为50万个，多人领取时单次发放上限为100万个。
- 领取链接：一人领取时单次发放上限为50万个，多人领取时单次发放上限为100万个。
发放给指定用户
为了更精准地将定制红包封面发放给指定用户，平台提供两种方式：通过鉴权接口发放（面向小程序开发者）、上传用户白名单。
通过鉴权接口发放
定制方可以添加微信小程序的appid，获取指定微信小程序的ctoken。小程序开发者可将ctoken配置在微信小程序的服务端，只有指定用户可以从小程序领取。开发者可以调用以下接口配置鉴权发放，点击查看具体调用方法。
接口名称：
redpacketcover.getAuthenticationUrl
上传用户白名单
定制方可以上传 openid 名单，只有名单里的微信用户可以领取。 上传名单文件前，可以先了解如何获取openid。
openid文件规格要求：
- 每个openid需通过回车分隔
- 文件大小：≤500KB
- 文件类型：txt
在公众号发放封面
已微信认证的公众号可在微信公众平台添加“微信红包封面”功能插件。添加插件后，已购买红包封面并生成了多人领取（且未指定用户）发放材料的公众号，可在编辑图文消息时插入“红包封面卡片”用于发放指定的红包封面。
在微信公众平台配置：
第一步：登录本平台帐号对应的公众号，开通“微信红包封面”功能插件。
第二步：新建或打开一篇图文素材，点击工具栏的“红包封面”组件按钮，即可选择红包封面插入。每篇文章至多可以添加3个“红包封面卡片”，每款红包封面在同一篇文章内只可以被添加一次，每次至多可添加10份发放材料。
用户领取方式：
用户在文章中点击“红包封面卡片”即可领取对应的红包封面。
用户如果已经领取过该红包封面，会看到页面显示“已领取红包封面”。用户尚未领取时，若该红包封面已被全部领取完，用户会看到页面显示“红包封面已领完”。
在小程序发放封面
生成领取链接后，开发者可将其配置在微信小程序中。配置成功后，用户可在小程序中领取红包封面。开发者可以调用以下接口配置领取链接，点击查看具体调用方法。
接口名称：
wx.showRedPackage
应注意，仅支持微信App7.0.9及以上版本。调用前，可使用canIUse判断是否可用。
回收
对于已发放的领取二维码/领取序列号/领取链接，若仍未被用户领取，定制方可以选择回收。
回收后，已发放的领取二维码/领取序列号/领取链接将失效，用户将无法领取。
封面兑换卡
未发完的封面可通过封面兑换卡，兑换成其他样式的封面继续发放。兑换后的封面不可再次转为封面兑换卡。
生成封面兑换卡：
在订单详情页，点击“转为封面兑换卡”，即可生成封面兑换卡，同时当前封面剩余可发放数量将相应减少。如果发放材料尚未被领取完，也可在“回收”后“转为封面兑换卡”。
使用封面兑换卡兑换其他封面：
点击右上角“个人中心 - 封面兑换卡”，选择一个要使用的封面兑换卡，点击“兑换封面”，即可选择一款封面进行兑换。兑换的封面，发放有效期与原封面一致，需在原封面购买后的6个月内发放。兑换后的封面不可再次转为封面兑换卡。
