W3Cschool
恭喜您成為首批注冊(cè)用戶
獲得88經(jīng)驗(yàn)值獎(jiǎng)勵(lì)
本接口應(yīng)在服務(wù)器端調(diào)用,詳細(xì)說明參見服務(wù)端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載)
wx-server-sdk >= 0.4.0
獲取小程序碼,適用于需要的碼數(shù)量極多的業(yè)務(wù)場(chǎng)景。通過該接口生成的小程序碼,永久有效,數(shù)量暫無限制。 更多用法詳見 獲取二維碼。
調(diào)用方式:
POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
access_token | string | 是 | 接口調(diào)用憑證 | |
scene | string | 是 | 最大32個(gè)可見字符,只支持?jǐn)?shù)字,大小寫英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~ ,其它字符請(qǐng)自行編碼為合法字符(因不支持% ,中文無法使用 urlencode 處理,請(qǐng)使用其他編碼方式) |
|
page | string | 主頁 | 否 | 必須是已經(jīng)發(fā)布的小程序存在的頁面(否則報(bào)錯(cuò)),例如 pages/index/index , 根路徑前不要填加 / ,不能攜帶參數(shù)(參數(shù)請(qǐng)放在scene字段里),如果不填寫這個(gè)字段,默認(rèn)跳主頁面 |
width | number | 430 | 否 | 二維碼的寬度,單位 px,最小 280px,最大 1280px |
auto_color | boolean | false | 否 | 自動(dòng)配置線條顏色,如果顏色依然是黑色,則說明不建議配置主色調(diào),默認(rèn) false |
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
JSON
屬性 | 類型 | 說明 |
---|---|---|
errcode | number | 錯(cuò)誤碼 |
errmsg | string | 錯(cuò)誤信息 |
errcode 的合法值
值 | 說明 | 最低版本 |
---|---|---|
45009 | 調(diào)用分鐘頻率受限(目前5000次/分鐘,會(huì)調(diào)整),如需大量小程序碼,建議預(yù)生成。 | |
41030 | 所傳page頁面不存在,或者小程序沒有發(fā)布 |
如果調(diào)用成功,會(huì)直接返回圖片二進(jìn)制內(nèi)容,如果請(qǐng)求失敗,會(huì)返回 JSON 格式的數(shù)據(jù)。
scene 字段的值會(huì)作為 query 參數(shù)傳遞給小程序/小游戲。用戶掃描該碼進(jìn)入小程序/小游戲后,開發(fā)者可以獲取到二維碼中的 scene 值,再做處理邏輯。
調(diào)試階段可以使用開發(fā)工具的條件編譯自定義參數(shù) scene=xxxx 進(jìn)行模擬,開發(fā)工具模擬時(shí)的 scene 的參數(shù)值需要進(jìn)行 encodeURIComponent
小程序
Page({
onLoad (query) {
// scene 需要使用 decodeURIComponent 才能獲取到生成二維碼時(shí)傳入的 scene
const scene = decodeURIComponent(query.scene)
}
})
小游戲
// 在首次啟動(dòng)時(shí)通過 wx.getLaunchOptionsSync 接口獲取
const {query} = wx.getLaunchOptionsSync()
const scene = decodeURIComponent(query.scene)
// 或者在 wx.onShow 事件中獲取
wx.onShow(function ({query}) {
// scene 需要使用 decodeURIComponent 才能獲取到生成二維碼時(shí)傳入的 scene
const scene = decodeURIComponent(query.scene)
})
請(qǐng)求
{
"scene": "a=1"
}
返回
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": Buffer
}
云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。
openapi.wxacode.getUnlimited
需在 config.json 中配置 wxacode.getUnlimited API 的權(quán)限,詳情
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
scene | string | 是 | 最大32個(gè)可見字符,只支持?jǐn)?shù)字,大小寫英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~ ,其它字符請(qǐng)自行編碼為合法字符(因不支持% ,中文無法使用 urlencode 處理,請(qǐng)使用其他編碼方式) |
|
page | string | 主頁 | 否 | 必須是已經(jīng)發(fā)布的小程序存在的頁面(否則報(bào)錯(cuò)),例如 pages/index/index , 根路徑前不要填加 / ,不能攜帶參數(shù)(參數(shù)請(qǐng)放在scene字段里),如果不填寫這個(gè)字段,默認(rèn)跳主頁面 |
width | number | 430 | 否 | 二維碼的寬度,單位 px,最小 280px,最大 1280px |
autoColor | boolean | false | 否 | 自動(dòng)配置線條顏色,如果顏色依然是黑色,則說明不建議配置主色調(diào),默認(rèn) false |
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í),生成透明底色的小程序 |
包含二進(jìn)制數(shù)據(jù)及其數(shù)據(jù)類型的對(duì)象
屬性 | 類型 | 說明 |
---|---|---|
contentType | String | 數(shù)據(jù)類型 (MIME Type) |
buffer | Buffer | 數(shù)據(jù) Buffer |
JSON
屬性 | 類型 | 說明 |
---|---|---|
errCode | number | 錯(cuò)誤碼 |
errMsg | string | 錯(cuò)誤信息 |
errCode 的合法值
值 | 說明 | 最低版本 |
---|
請(qǐng)求
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.wxacode.getUnlimited({
scene: 'a=1'
})
return result
} catch (err) {
return err
}
}
返回
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": Buffer
}
Copyright©2021 w3cschool編程獅|閩ICP備15016281號(hào)-3|閩公網(wǎng)安備35020302033924號(hào)
違法和不良信息舉報(bào)電話:173-0602-2364|舉報(bào)郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號(hào)
聯(lián)系方式:
更多建議: