获取小程序码

获取小程序码

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

接口说明

接口英文名

getQRCode

功能描述

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

注意事项

• 如果调用成功，会直接返回图片二进制内容，如果请求失败，会返回 JSON 格式的数据。
• POST 参数需要转成 JSON 字符串，不支持 form 表单提交。
• 与 createQRCode 总共生成的码数量限制为 100,000，请谨慎调用。已生成码数量参考HTTP Header的Num-Used。

调用方式

HTTPS 调用

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

第三方调用

• 调用方式以及出入参和HTTPS相同，仅是调用的token不同
• 该接口所属的权限集id为：17、58
• 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

请求参数

	属性	类型	必填	说明
	access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用getAccessToken 或者 authorizer_access_token
	path	string	是	扫码进入的小程序页面路径，最大长度 1024 个字符，不能为空，scancode_time为系统保留参数，不允许配置；对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"，即可在 wx.getLaunchOptionsSync 接口中的 query 参数获取到 {foo:"bar"}。
	width	number	否	二维码的宽度，单位 px。默认值为430，最小 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"} 十进制表示
	属性类型必填说明r是默认值{"r":0,"g":0,"b":0} ；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示g是默认值{"r":0,"g":0,"b":0} ；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示b是默认值{"r":0,"g":0,"b":0} ；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示
	is_hyaline	boolean	否	默认值false；是否需要透明底色，为 true 时，生成透明底色的小程序码
	env_version	string	否	要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"。默认是正式版。

返回参数

属性	类型	说明
buffer	buffer	图片 Buffer
errcode	number	错误码
errmsg	string	错误信息

调用示例

示例说明: HTTP调用示例（成功）

请求数据示例

{
"path":"funpackage/questionsWall/questionInfo?question_id=22579",
"env_version": "release",
"width":280
} 

返回数据示例

图片 Buffer 

示例说明: HTTP调用示例（失败）

请求数据示例

{
"path":"",
"env_version": "release",
"width":280
} 

返回数据示例

{
 "errcode":  40159,
 "errmsg": "invalid length for path  or thedata is not json string"
} 

示例说明: 云调用示例（成功）

请求数据示例

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
      })
    return result
  } catch (err) {
    return err
  }
} 

返回数据示例

图片 Buffer 

错误码

错误码	错误描述	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
40159	invalid length for path or thedata is not json string	path 不能为空，且长度不能大于1024
45029	qrcode count out of limit	生成码个数总和到达最大个数限制
85096	not allow include scancode_time field	scancode_time为系统保留参数，不允许配置
40097	invalid args	参数错误