# wxacode.getUnlimited

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

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

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

调用方式：

HTTPS 调用
云调用

# HTTPS 调用

# 请求地址

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

# 请求参数 - Query

属性	类型	默认值	必填	说明
access_token / cloudbase_access_token	string		是	接口调用凭证

# 请求参数 - Body

属性	类型	默认值	必填	说明
scene	string		是	最大 32 个可见字符，只支持数字，大小写英文以及部分特殊字符：`!#$&'()*+,/:;=?@-._~`，其它字符请自行编码为合法字符（因不支持`%`，中文无法使用 `urlencode` 处理，请使用其他编码方式）
page	string	主页	否	页面 page，例如 `pages/index/index`，根路径前不要填加 `/`，不能携带参数（参数请放在 scene 字段里），如果不填写这个字段，默认跳主页面
check_path	boolean	true	否	检查 page 是否存在，为 `true` 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 `false` 时允许小程序未发布或者 page 不存在，但 page 有数量上限（60000 个）请勿滥用
env_version	string	"release"	否	要打开的小程序版本。正式版为 `release`，体验版为 `trial`，开发版为 `develop`
width	number	430	否	二维码的宽度，单位 px，最小 280px，最大 1280px
auto_color	boolean	false	否	自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认 false
line_color	Object	{"r":0,"g":0,"b":0}	否	auto_color 为 false 时生效，使用 rgb 设置颜色例如 `{"r":"xxx","g":"xxx","b":"xxx"}` 十进制表示
is_hyaline	boolean	false	否	是否需要透明底色，为 true 时，生成透明底色的小程序

# 返回值

# Buffer

返回的图片 Buffer

# 异常返回

# Object

JSON

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息

errcode 的合法值

值	说明	最低版本
-1	系统繁忙，请稍后重试
45063	暂无生成权限
45009	调用分钟频率受限(目前 5000 次/分钟，会调整)，如需大量小程序码，建议预生成
41030	page 不合法（页面不存在或者小程序没有发布、根路径前加 `/`或者携带参数）
40169	scene 字符长度不合法
40129	scene 字符格式不合法
40097	env_version 不合法

# 返回值说明

如果调用成功，会直接返回图片二进制内容，如果请求失败，会返回 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);
});

# 示例

请求

{
  "page": "pages/index/index",
  "scene": "a=1",
  "check_path": true,
  "env_version": "release"
}

Buffer

# 云调用

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

# 接口方法

openapi.wxacode.getUnlimited;

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

# 请求参数

属性	类型	默认值	必填	说明
scene	string		是	最大 32 个可见字符，只支持数字，大小写英文以及部分特殊字符：`!#$&'()*+,/:;=?@-._~`，其它字符请自行编码为合法字符（因不支持`%`，中文无法使用 `urlencode` 处理，请使用其他编码方式）
page	string	主页	否	页面 page，例如 `pages/index/index`，根路径前不要填加 `/`，不能携带参数（参数请放在 scene 字段里），如果不填写这个字段，默认跳主页面
checkPath	boolean	true	否	检查 page 是否存在，为 `true` 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 `false` 时允许小程序未发布或者 page 不存在，但 page 有数量上限（60000 个）请勿滥用
envVersion	string	"release"	否	要打开的小程序版本。正式版为 `release`，体验版为 `trial`，开发版为 `develop`
width	number	430	否	二维码的宽度，单位 px，最小 280px，最大 1280px
autoColor	boolean	false	否	自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认 false
lineColor	Object	{"r":0,"g":0,"b":0}	否	auto_color 为 false 时生效，使用 rgb 设置颜色例如 `{"r":"xxx","g":"xxx","b":"xxx"}` 十进制表示
isHyaline	boolean	false	否	是否需要透明底色，为 true 时，生成透明底色的小程序

# 返回值

# Object

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

属性	类型	说明
contentType	String	数据类型 (MIME Type)
buffer	Buffer	数据 Buffer

# 异常

# Object

JSON

属性	类型	说明
errCode	number	错误码
errMsg	string	错误信息

errCode 的合法值

值	说明	最低版本

# 示例

请求

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;
  }
};

Buffer