# wxacode.getUnlimited

Call this API at the server side. For more information, see Server API.

This API supports Cloud Calls. The WeChat DevTools version must be 1.02.1904090 or later (download the latest stable version here), and the wx-server-sdk version must be 0.4.0 or later.

Obtains the Mini Program code in scenarios where a large number of codes are required. Mini Program codes generated via this API are permanently effective. There is no upper limit on the number of codes. For more information on how to use it, see Obtaining QR Codes.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

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

# Request Parameters

# Return Value

# Buffer

An image buffer is returned.

# Exception Response

# Object

JSON

Valid values of errcode

# Return Values

If the call is successful, binary content of the image is directly returned; if the call failed, data in the JSON format is returned.

# Notes

• POST parameters need to be converted into JSON strings, and cannot be submitted in forms.
• This API can only be used to generate the QR codes of published Mini Programs.
• The number of calls to this API per minute is limited to 5000. If a large number of Mini Program codes are required, pre-generation is recommended.

# Obtaining Scene Values

The value of the scene field is passed to a Mini Program/Mini Game as a query parameter. After a user scans this code to enter the Mini Program/Mini Game, developers can obtain the scene value from the QR code and then process the logic.

During debugging, developers can simulate the scene by customizing the parameter scene=xxxx via conditional compilation in WeChat DevTools. The encodeURIComponent API needs to be called for the scene value during the simulation.

Mini Program

Page({
  onLoad (query) {
    // scene must use decodeURIComponent to obtain the scene value provided during QR code generation.
    const scene = decodeURIComponent(query.scene)
  }
})

Mini Game

// Obtains the scene value via the `wx.getLaunchOptionsSync` API during initial startup.
const {query} = wx.getLaunchOptionsSync()
const scene = decodeURIComponent(query.scene)

// or obtains the scene value from the wx.onShow event.
wx.onShow(function ({query}) {
  // scene must use decodeURIComponent to obtain the scene value provided during QR code generation.
  const scene = decodeURIComponent(query.scene)
})

# Example

Request

{
 "scene": "a=1"
}

Response

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

# Cloud Call

Cloud call is a capability provided by Mini Program·Cloud Base that allows you to call WeChat APIs in a cloud function. It must be used via wx-server-sdk in the cloud function.

# API Calling Method

openapi.wxacode.getUnlimited

You need to configure the permissions for the wxacode.getUnlimited API via config.json. Details

# Request Parameters

# Return Value

# Object

Returns an object containing binary data and its data type.

# Exceptions

# Object

JSON

Valid values of errCode

# Example

Request

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.wxacode.getUnlimited({
        scene: 'a=1'
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

Response

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