# wxacode.get

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

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

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

调用方式：

HTTPS 调用
云调用

# HTTPS 调用

# 请求地址

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

# 请求参数

属性	类型	默认值	必填	说明
access_token / cloudbase_access_token	string		是	接口调用凭证
path	string		是	扫码进入的小程序页面路径，最大长度 1024 字节，不能为空；对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"，即可在 `wx.getLaunchOptionsSync` 接口中的 query 参数获取到 `{foo:"bar"}`。
env_version	string	"release"	否	要打开的小程序版本。正式版为 `release`，体验版为 `trial`，开发版为 `develop`
width	number	430	否	二维码的宽度，单位 px。最小 280px，最大 1280px
auto_color	boolean	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	生成码超过每天最大个数限制（1 万/天）
45029	生成码个数总和到达最大个数限制
40159	path 长度不合法
40189	width 长度不合法
40097	env_version 不合法

# 返回值说明

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

# 注意

POST 参数需要转成 JSON 字符串，不支持 form 表单提交。
接口只能生成已发布的小程序的二维码。
与 wxacode.createQRCode 总共生成的码数量限制为 100,000，请谨慎调用。已生成码数量参考HTTP Header的Num-Used。

# 示例

请求

{
 "path":"page/index/index",
 "env_version": "release",
 "width":430
}

Buffer

# 云调用

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

# 接口方法

openapi.wxacode.get

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

# 请求参数

属性	类型	默认值	必填	说明
path	string		是	扫码进入的小程序页面路径，最大长度 128 字节，不能为空；对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"，即可在 `wx.getLaunchOptionsSync` 接口中的 query 参数获取到 `{foo:"bar"}`。
envVersion	string	"release"	否	要打开的小程序版本。正式版为 `release`，体验版为 `trial`，开发版为 `develop`
width	number	430	否	二维码的宽度，单位 px。最小 280px，最大 1280px
autoColor	boolean	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.get({
        "path": 'page/index/index',
        "width": 430,
        "envVersion": 'release'
      })
    return result
  } catch (err) {
    return err
  }
}

Buffer