微信小程序 createQRCode

2022-05-11 15:00 更新

wxacode.createQRCode

本接口應(yīng)在服務(wù)器端調(diào)用,詳細說明參見服務(wù)端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

獲取小程序二維碼,適用于需要的碼數(shù)量較少的業(yè)務(wù)場景。通過該接口生成的小程序碼,永久有效,有數(shù)量限制,詳見獲取二維碼。

調(diào)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請求地址

POST https://api.weixin.qq.com/cgi-bin/wxaapp/createwxaqrcode?access_token=ACCESS_TOKEN

請求參數(shù)

屬性 類型 默認值 必填 說明
access_token string 接口調(diào)用憑證
path string 掃碼進入的小程序頁面路徑,最大長度 128 字節(jié),不能為空;對于小游戲,可以只傳入 query 部分,來實現(xiàn)傳參效果,如:傳入 "?foo=bar",即可在 wx.getLaunchOptionsSync 接口中的 query 參數(shù)獲取到 {foo:"bar"}
width number 430 二維碼的寬度,單位 px。最小 280px,最大 1280px

返回值

Buffer

返回的圖片 Buffer

異常返回

Object

JSON

屬性 類型 說明
errcode number 錯誤碼
errmsg string 錯誤信息

errcode 的合法值

說明 最低版本
45029 生成碼個數(shù)總和到達最大個數(shù)限制

返回值說明

如果調(diào)用成功,會直接返回圖片二進制內(nèi)容,如果請求失敗,會返回 JSON 格式的數(shù)據(jù)。

注意

  • POST 參數(shù)需要轉(zhuǎn)成 JSON 字符串,不支持 form 表單提交。
  • 接口只能生成已發(fā)布的小程序的二維碼。開發(fā)版的帶參二維碼可以在開發(fā)者工具預(yù)覽時生成。
  • 與 wxacode.get 總共生成的碼數(shù)量限制為 100,000,請謹慎調(diào)用。

示例

請求

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

返回

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

云調(diào)用

云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。

接口方法

openapi.wxacode.createQRCode
需在 config.json 中配置 wxacode.createQRCode API 的權(quán)限,詳情

請求參數(shù)

屬性 類型 默認值 必填 說明
path string 掃碼進入的小程序頁面路徑,最大長度 128 字節(jié),不能為空;對于小游戲,可以只傳入 query 部分,來實現(xiàn)傳參效果,如:傳入 "?foo=bar",即可在 wx.getLaunchOptionsSync 接口中的 query 參數(shù)獲取到 {foo:"bar"}。
width number 430 二維碼的寬度,單位 px。最小 280px,最大 1280px

返回值

Object

包含二進制數(shù)據(jù)及其數(shù)據(jù)類型的對象

屬性 類型 說明
contentType String 數(shù)據(jù)類型 (MIME Type)
buffer Buffer 數(shù)據(jù) Buffer

異常

Object

JSON

屬性 類型 說明
errCode number 錯誤碼
errMsg string 錯誤信息

errCode 的合法值

說明 最低版本

示例

請求

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.wxacode.createQRCode({
        path: 'page/index/index',
        width: 430
      })
    return result
  } catch (err) {
    return err
  }
}

返回

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


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號