# 获取微信红包封面
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getRedPacketCoverUrl
本接口用于获得指定用户可以领取的红包封面链接。获取参数ctoken参考微信红包封面开放平台。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/redpacketcover/wxapp/cover_url/get_by_token?access_token=ACCESS_TOKEN
# 云调用
调用方法:redpacketcover.getAuthenticationUrl
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:112
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 是 | 可领取用户的openid |
| ctoken | string | 是 | 在红包封面平台获取发放ctoken(需要指定可以发放的appid) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误描述 |
| data | object | 指定用户可以领取的链接(带鉴权的链接) |
# Res.data Object Payload
指定用户可以领取的链接(带鉴权的链接)
| 参数名 | 类型 | 说明 |
|---|---|---|
| url | string | 指定用户可以领取的链接(带鉴权的链接) |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"openid": "xxxxxxxxxxmTo5lAUQxxxxxxxxxx",
"ctoken": "xxxxxqpHPu1xxxxx"
}
返回示例
{
"data": {
"url": "https://xxx.xxx.xxx.xxx/xxx"
},
"errcode": 0,
"errmsg": "success"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
| 9600001 | 参数缺失 openid | |
| 9600002 | 参数缺失 ctoken | |
| 9600003 | 系统错误 | |
| 9600004 | ctoken 错误 | |
| 9600005 | openid 错误 | |
| 9600006 | 小程序不在配置列表中 | |
| 9600007 | 小程序与openid不对应 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。