# 获取小程序码

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getQRCode

该接口用于获取小程序码，适用于需要的码数量较少的业务场景。通过该接口生成的小程序码，永久有效，有数量限制，详见[获取小程序码](/miniprogram/dev/framework/open-ability/qr-code.md)。

## 1. 调用方式

### HTTPS 调用

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

> **支持加密请求：** 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。[查看详情](/miniprogram/dev/server/getting_started/api_signature.md)

### 云调用

- 调用方法：wxacode.get

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：17

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/minigame/dev/api-backend/access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "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}\t；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {\"r\":\"xxx\",\"g\":\"xxx\",\"b\":\"xxx\"} 十进制表示"
  },
  {
    "参数名": "is_hyaline",
    "类型": "boolean",
    "必填": "否",
    "说明": "默认值false；是否需要透明底色，为 true 时，生成透明底色的小程序码"
  },
  {
    "参数名": "env_version",
    "类型": "string",
    "必填": "否",
    "说明": "要打开的小程序版本。正式版为 \"release\"，体验版为 \"trial\"，开发版为 \"develop\"。默认是正式版。"
  }
]
```

### Body.line_color `Object Payload`

默认值{"r":0,"g":0,"b":0}	；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示

```json
[
  {
    "参数名": "r",
    "类型": "-",
    "必填": "是",
    "说明": "默认值{\"r\":0,\"g\":0,\"b\":0}\t；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {\"r\":\"xxx\",\"g\":\"xxx\",\"b\":\"xxx\"} 十进制表示"
  },
  {
    "参数名": "g",
    "类型": "-",
    "必填": "是",
    "说明": "默认值{\"r\":0,\"g\":0,\"b\":0}\t；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {\"r\":\"xxx\",\"g\":\"xxx\",\"b\":\"xxx\"} 十进制表示"
  },
  {
    "参数名": "b",
    "类型": "-",
    "必填": "是",
    "说明": "默认值{\"r\":0,\"g\":0,\"b\":0}\t；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {\"r\":\"xxx\",\"g\":\"xxx\",\"b\":\"xxx\"} 十进制表示"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "buffer",
    "类型": "buffer",
    "说明": "图片 Buffer"
  },
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

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

## 5. 代码示例

### 5.1 HTTP调用示例（成功）

请求示例

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

返回示例

```
图片 Buffer
```

### 5.2 HTTP调用示例（失败）

请求示例

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

返回示例

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

### 5.3 云调用示例（成功）

请求示例

```json
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
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "40097",
    "错误描述": "invalid args",
    "解决方案": "参数错误"
  },
  {
    "错误码": "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为系统保留参数，不允许配置"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "小游戏": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。