wxacode.getUnlimited

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

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

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
accesstokenstring接口调用凭证
scenestring最大32个可见字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-.~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式)
pagestring主页必须是已经发布的小程序存在的页面(否则报错),例如 pages/index/index, 根路径前不要填加 /,不能携带参数(参数请放在scene字段里),如果不填写这个字段,默认跳主页面
widthnumber430二维码的宽度,单位 px,最小 280px,最大 1280px
auto_colorbooleanfalse自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调,默认 false
line_colorObject{"r":0,"g":0,"b":0}auto_color 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示
is_hyalinebooleanfalse是否需要透明底色,为 true 时,生成透明底色的小程序

返回值

Buffer

返回的图片 Buffer

异常返回

Object

JSON

属性类型说明
errcodenumber错误码
errmsgstring错误信息

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.getLaunchOptionsSync 接口获取
  2. const {query} = wx.getLaunchOptionsSync()
  3. const scene = decodeURIComponent(query.scene)
  4. // 或者在 wx.onShow 事件中获取
  5. wx.onShow(function ({query}) {
  6. // scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
  7. const scene = decodeURIComponent(query.scene)
  8. })

示例

请求

  1. {
  2. "scene": "a=1"
  3. }

返回

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "contentType": "image/jpeg",
  5. "buffer": Buffer
  6. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.wxacode.getUnlimited

需在 config.json 中配置 wxacode.getUnlimited API 的权限,详情

请求参数

属性类型默认值必填说明
scenestring最大32个可见字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式)
pagestring主页必须是已经发布的小程序存在的页面(否则报错),例如 pages/index/index, 根路径前不要填加 /,不能携带参数(参数请放在scene字段里),如果不填写这个字段,默认跳主页面
widthnumber430二维码的宽度,单位 px,最小 280px,最大 1280px
autoColorbooleanfalse自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调,默认 false
lineColorObject{"r":0,"g":0,"b":0}auto_color 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示
isHyalinebooleanfalse是否需要透明底色,为 true 时,生成透明底色的小程序

返回值

Object

包含二进制数据及其数据类型的对象

属性类型说明
contentTypeString数据类型 (MIME Type)
bufferBuffer数据 Buffer

异常

Object

JSON

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本

示例

请求

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4. try {
  5. const result = await cloud.openapi.wxacode.getUnlimited({
  6. scene: 'a=1'
  7. })
  8. console.log(result)
  9. return result
  10. } catch (err) {
  11. console.log(err)
  12. return err
  13. }
  14. }

返回

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "contentType": "image/jpeg",
  5. "buffer": Buffer
  6. }