微信小程序 get

2022-05-11 15:01 更新

wxacode.get

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

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

調(diào)用方式:

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

HTTPS 調(diào)用

請(qǐng)求地址

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

請(qǐng)求參數(shù)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
access_token string 接口調(diào)用憑證
path string 掃碼進(jìn)入的小程序頁(yè)面路徑,最大長(zhǎng)度 128 字節(jié),不能為空;對(duì)于小游戲,可以只傳入 query 部分,來(lái)實(shí)現(xiàn)傳參效果,如:傳入 "?foo=bar",即可在 wx.getLaunchOptionsSync 接口中的 query 參數(shù)獲取到 {foo:"bar"}。
width number 430 二維碼的寬度,單位 px。最小 280px,最大 1280px
auto_color boolean false 自動(dòng)配置線條顏色,如果顏色依然是黑色,則說(shuō)明不建議配置主色調(diào)
line_color Object {"r":0,"g":0,"b":0} auto_color 為 false 時(shí)生效,使用 rgb 設(shè)置顏色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十進(jìn)制表示
is_hyaline boolean false 是否需要透明底色,為 true 時(shí),生成透明底色的小程序碼

返回值

Buffer

返回的圖片 Buffer

異常返回

Object

JSON

屬性 類(lèi)型 說(shuō)明
errcode number 錯(cuò)誤碼
errmsg string 錯(cuò)誤信息

errcode 的合法值

說(shuō)明 最低版本
45029 生成碼個(gè)數(shù)總和到達(dá)最大個(gè)數(shù)限制

返回值說(shuō)明

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

注意

  • POST 參數(shù)需要轉(zhuǎn)成 JSON 字符串,不支持 form 表單提交。
  • 接口只能生成已發(fā)布的小程序的二維碼
  • 與 wxacode.createQRCode 總共生成的碼數(shù)量限制為 100,000,請(qǐng)謹(jǐn)慎調(diào)用。

示例

請(qǐng)求

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

返回

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

云調(diào)用

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

接口方法

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

請(qǐng)求參數(shù)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
path string 掃碼進(jìn)入的小程序頁(yè)面路徑,最大長(zhǎng)度 128 字節(jié),不能為空;對(duì)于小游戲,可以只傳入 query 部分,來(lái)實(shí)現(xiàn)傳參效果,如:傳入 "?foo=bar",即可在 wx.getLaunchOptionsSync 接口中的 query 參數(shù)獲取到 {foo:"bar"}。
width number 430 二維碼的寬度,單位 px。最小 280px,最大 1280px
autoColor boolean false 自動(dòng)配置線條顏色,如果顏色依然是黑色,則說(shuō)明不建議配置主色調(diào)
lineColor Object {"r":0,"g":0,"b":0} auto_color 為 false 時(shí)生效,使用 rgb 設(shè)置顏色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十進(jìn)制表示
isHyaline boolean false 是否需要透明底色,為 true 時(shí),生成透明底色的小程序碼

返回值

Object

包含二進(jìn)制數(shù)據(jù)及其數(shù)據(jù)類(lèi)型的對(duì)象

屬性 類(lèi)型 說(shuō)明
contentType String 數(shù)據(jù)類(lèi)型 (MIME Type)
buffer Buffer 數(shù)據(jù) Buffer

異常

Object

JSON

屬性 類(lèi)型 說(shuō)明
errCode number 錯(cuò)誤碼
errMsg string 錯(cuò)誤信息

errCode 的合法值

說(shuō)明 最低版本

示例

請(qǐng)求

const cloud = require('wx-server-sdk')
cloud.init()
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
  }
}

返回

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


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

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)