获取小程序码

调用本 API 可以获取小程序码,适用于需要的码数量较少的业务场景。通过该接口生成的小程序码,永久有效,有数量限制。使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

请求地址

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

请求参数说明

属性 类型 默认值 必填 说明
access_token string 第三方平台接口调用令牌authorizer_access_token
path string 扫码进入的小程序页面路径,最大长度 128 字节,不能为空;对于小游戏,可以只传入 query 部分,来实现传参效果,如:传入 "?foo=bar",即可在 wx.getLaunchOptionsSync 接口中的 query 参数获取到 {foo:"bar"}
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 时,生成透明底色的小程序码

注意

  • POST 参数需要转成 JSON 字符串,不支持 form 表单提交。
  • 接口只能生成已发布的小程序的二维码
  • 获取小程序二维码 总共生成的码数量限制为 100,000,请谨慎调用。

返回参数说明

Object

返回的 JSON 数据包

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

请求数据示例

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

返回数据示例

{
 "errcode": 0,
 "errmsg": "ok",
 "contentType": "image/jpeg",
 "buffer": Buffer
}

返回码说明

错误码 英文描述 中文描述
0 ok 成功
45029 生成码个数总和到达最大个数限制
其他错误码 请查看全局错误码