getWXACodeUnlimit

获取小程序码,适用于需要的码数量极多的业务场景。通过该接口生成的小程序码,永久有效,数量暂无限制。 更多用法详见 获取二维码

请求地址

  1. POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN

参数

string access_token

接口调用凭证

string scene

最大32个可见字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式)

string page

必须是已经发布的小程序存在的页面(否则报错),例如 pages/index/index, 根路径前不要填加 /,不能携带参数(参数请放在scene字段里),如果不填写这个字段,默认跳主页面

number width

二维码的宽度,默认为 430px,最小 280px,最大 1280px

boolean auto_color

自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调,默认 false

Object line_color

auto_color 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示,默认全 0

boolean is_hyaline

是否需要透明底色,为 true 时,生成透明底色的小程序码,默认 false

返回值

Object

返回的 JSON 数据包

属性 类型 说明 支持版本
errcode number 错误码
errmsg string 错误信息

errcode 的合法值

说明
45009 调用分钟频率受限(目前5000次/分钟,会调整),如需大量小程序码,建议预生成。
41030 所传page页面不存在,或者小程序没有发布

返回值说明

如果调用成功,会直接返回图片二进制内容,如果请求失败,会返回 JSON 格式的数据。

注意

  • POST 参数需要转成 JSON 字符串,不支持 form 表单提交。
  • 接口只能生成已发布的小程序的二维码
  • 调用分钟频率受限(5000次/分钟),如需大量小程序码,建议预生成

    获取 scene 值

scene 字段的值会作为 query 参数传递给小程序/小游戏。用户扫描该码进入小程序/小游戏后,开发者可以获取到二维码中的 scene 值,再做处理逻辑。

调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟,开发工具模拟时的 scene 的参数值需要进行 encodeURIComponent

小程序

  1. Page({
  2. onLoad (query) {
  3. // scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
  4. const scene = decodeURIComponent(query.scene)
  5. }
  6. })

小游戏

  1. wx.onShow(function ({query}) {
  2. // scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
  3. const scene = decodeURIComponent(query.scene)
  4. })

原文: https://developers.weixin.qq.com/minigame/dev/api/open-api/qr-code/getWXACodeUnlimit.html