# 获取不限制的小程序码
接口应在服务器端调用，详细说明参见服务端API。
# 接口说明
# 接口英文名
getUnlimitedQRCode
# 功能描述
该接口用于获取小程序码，适用于需要的码数量极多的业务场景。通过该接口生成的小程序码，永久有效，数量暂无限制。 更多用法详见 获取小程序码。
# 注意事项
- 如果调用成功，会直接返回图片二进制内容，如果请求失败，会返回 JSON 格式的数据。
- POST 参数需要转成 JSON 字符串，不支持 form 表单提交。
- 调用分钟频率受限（5000次/分钟），如需大量小程序码，建议预生成
# 获取 scene 值
- scene 字段的值会作为 query 参数传递给小程序/小游戏。用户扫描该码进入小程序/小游戏后，开发者可以获取到二维码中的 scene 值，再做处理逻辑。
- 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟，开发工具模拟时的 scene 的参数值需要进行 encodeURIComponent
# 小程序
Page({
onLoad (query) {
// scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
const scene = decodeURIComponent(query.scene)
}
})
# 小游戏
// 在首次启动时通过 wx.getLaunchOptionsSync 接口获取
const {query} = wx.getLaunchOptionsSync()
const scene = decodeURIComponent(query.scene)
// 或者在 wx.onShow 事件中获取
wx.onShow(function ({query}) {
// scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
const scene = decodeURIComponent(query.scene)
})
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：17、58
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用
# 请求参数
| 属性 | 类型 | 必填 | 说明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。使用getAccessToken 或者 authorizer_access_token | ||||||
| scene | string | 是 | 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式） | ||||||
| page | string | 否 | 默认是主页，页面 page，例如 pages/index/index，根路径前不要填加 /，不能携带参数（参数请放在scene字段里），如果不填写这个字段，默认跳主页面。scancode_time为系统保留参数，不允许配置 | ||||||
| check_path | bool | 否 | 默认是true，检查page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在， 但page 有数量上限（60000个）请勿滥用。 | ||||||
| env_version | string | 否 | 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"。默认是正式版。 | ||||||
| width | number | 否 | 默认430，二维码的宽度，单位 px，最小 280px，最大 1280px | ||||||
| auto_color | bool | 否 | 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认 false | ||||||
| line_color | object | 否 | 默认是{"r":0,"g":0,"b":0} 。auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示 | ||||||
| |||||||||
| is_hyaline | bool | 否 | 默认是false，是否需要透明底色，为 true 时，生成透明底色的小程序 | ||||||
# 返回参数
| 属性 | 类型 | 说明 |
|---|---|---|
| buffer | buffer | 图片 Buffer |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 调用示例
示例说明: HTTPS调用
# 请求数据示例
{
"page": "pages/index/index",
"scene": "a=1",
"check_path": true,
"env_version": "release"
}
# 返回数据示例
图片二进制
示例说明: 云函数调用
# 请求数据示例
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.wxacode.getUnlimited({
"page": 'pages/index/index',
"scene": 'a=1',
"checkPath": true,
"envVersion": 'release'
})
return result
} catch (err) {
return err
}
}
# 返回数据示例
图片二进制
# 错误码
| 错误码 | 错误码取值 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 40129 | invalid scene | 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式） |
| 41030 | invalid page | page路径不正确：根路径前不要填加 /，不能携带参数（参数请放在scene字段里），需要保证在现网版本小程序中存在，与app.json保持一致。 设置check_path=false可不检查page参数。 |
| 85096 | not allow include scancode_time field | scancode_time为系统保留参数，不允许配置 |
| 40097 | invalid args | 参数错误 |
| 40169 | invalid length for scene or thedata is not json string | scene 不合法 |