支付宝小程序Serverless 基础能力API·cloud.base.qrcode.create
cloud.base.qrcode.create 是小程序二维码场景 下创建小程序二维码的接口。
使用该API前,请确认你的小程序应用已经添加了 小程序二维码 功能
入参说明
字段名 | 类型 | 必填 | 说明 |
---|---|---|---|
urlParam | String | 是 | 小程序中能访问到的页面路径,例如:page/component/component-pages/view/view |
queryParam | String | 是 | 小程序的启动参数,打开小程序的query ,在小程序 onLaunch的方法中获取 |
describe | String | 是 | 二维码描述 |
appAuthToken | String | 否 | 三方代调用应用访问令牌,目前仅在云函数中调用支持。 |
调用示例
在云函数中调用
module.exports = async function (ctx) {
const res = await ctx.cloud.base.qrcode.create({
urlParam: 'pages/index/index',
describe: '我的二维码描述',
queryParam: 'key=value'
});
return res;
};
支持传入appAuthToken进行三方代调用
module.exports = async function (ctx) {
const res = await ctx.cloud.base.qrcode.create({
urlParam: 'pages/index/index',
describe: '我的二维码描述',
queryParam: 'key=value'
}, {
// appAuthToken参数接收自云函数调用处传入的参数
appAuthToken: ctx.args.appAuthToken
});
return res;
};
在小程序页面调用
alipay-serverless-sdk 版本&=1.0.0
import cloud from 'alipay-serverless-sdk';
const res = await cloud.base.qrcode.create({
urlParam: 'pages/index/index',
describe: '我的二维码描述',
queryParam: 'key=value'
});
alipay-serverless-sdk 版本<1.0.0
import cloud from 'alipay-serverless-sdk';
const res = await cloud.base.qrcode.create('pages/index/index', 'key=value', '我的二维码描述');
返回数据示例
{
"code":"10000",
"msg":"Success",
"qrCodeUrl":"https://mass.alipay.com/wsdk/img?fileid=A*023KQ47KNiYAAAAAAAAAAAAAAQAAAQ&bz=am_afts_openhome&zoom=original"
}