获取支付宝小程序二维码

BaaS.alipay.getAlipayQRCode({name, urlParam, queryParam, describe})

通过该接口可以获取小程序任意页面的二维码,扫描该二维码可以直接进入小程序对应的页面。

调用该接口前,请确保在 知晓云管理后台-小程序设置页面-SDK 功能设置 中已开启相应权限。

参数说明

参数类型必填说明
nameStringY二维码名称,最多 128 个字符
urlParamStringY页面地址,最多 128 个字符
queryParamStringY启动参数,最多 128 个字符
describeStringY码描述,最少 2 个字符,最多 20 个字符

接口返回

返回字段说明

参数类型说明
idString二维码 ID
nameString二维码名称
image_urlString二维码地址,二维码的下载链接
url_paramString页面地址
query_paramString启动参数
describeString描述

以下几种情况会返回 400 错误:

  • 未在知晓云后台开启生成小程序码权限
  • 传递的参数不合法

请求示例

  1. BaaS.alipay.getAlipayQRCode({
  2. name: "test",
  3. urlParam: "index",
  4. queryParam: "key=value&alpha=True",
  5. describe: "备注:扫码中大奖"})
  6. .then(res => {
  7. callback(null, res.image_url)
  8. })

HError 对象结构请参考错误码和 HError 对象

了解更多获取二维码的信息,可参考支付宝小程序文档 - 小程序二维码 章节