小程序 api 概览 -凯发app官方网站

更新时间：2024-12-30 15:18:23

订阅更新

我的文档

设置

简介

本文简要归纳了支付宝小程序前端 api 及其作用。

说明：

●

前端接口使用说明可查看

小程序 api 使用说明

。

●

错误码信息可查看

小程序 api 错误码对照表

。

基础 api

基础

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.caniuse	判断当前小程序的 api、入参或返回值、组件、属性等在当前版本是否支持。	✓	✓
my.env	获取小程序环境变量对象。	✓	✓
my.iside	判断当前环境是否为 ide 环境。	✓	✓
my.getlaunchoptionssync	获取小程序冷启动时的启动参数	✓	✓
my.getenteroptionssync	获取本次小程序启动时的参数。	✓	✓
my.sdkversion	获取基础库版本号。	✓	✓
my.getaccountinfosync	获取小程序以及插件的版本信息。	✓	✓
my.getappidsync	同步获取小程序 appid。	✓	✓
my.getrunscene	获取当前小程序的运行版本。	✓	✓
my.base64toarraybuffer	将 base64 字符串转成 arraybuffer 对象。	✓	✓
my.arraybuffertobase64	将 arraybuffer 对象转成 base64 字符串。	✓	✓
my.getperformance	获取小程序相关性能数据。	✓	✓

应用级事件

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.onappshow	监听小程序切前台事件。	✓	✓
my.offappshow	移除小程序切前台事件的监听函数。	✓	✓
my.onapphide	监听小程序切后台事件。	✓	✓
my.offapphide	移除小程序切后台事件的监听函数。	✓	✓
my.onpagenotfound	监听小程序要打开的页面不存在事件。	✓	✓
my.offpagenotfound	移除小程序要打开的页面不存在事件的监听函数。	✓	✓
my.onunhandledrejection	监听未处理的 promise 拒绝事件（即 unhandledrejection 事件）。	✓	✓
my.offunhandledrejection	移除未处理的 promise 拒绝事件的监听函数。	✓	✓
my.onerror	监听小程序错误事件。	✓	✓
my.offerror	移除小程序错误事件的监听函数。	✓	✓
my.oncomponenterror	监听小程序自定义组件内部 js 代码的 error 事件	✓	✓
my.offcomponenterror	移除小程序自定义组件内部 js 代码的 error 事件的监听函数。	✓	✓
my.onlazyloaderror	监听小程序异步组件（懒加载插件、分包异步化）加载失败事件。	✓	✓
my.offlazyloaderror	移除小程序异步组件（懒加载插件、分包异步化）加载失败事件监听函数。	✓	✓

界面

导航栏

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.setnavigationbar	设置导航栏标题和样式（前景色、背景色、底部边框颜色、左上角 logo 图片）。	✓	✓
my.setnavigationbartitle	设置导航栏标题。	✓	✓
my.setnavigationbarcolor	设置导航栏颜色。	✓	✓
my.setnavigationbarbottomlinecolor	设置导航栏底部边框颜色。	✓	✓
my.hidebackhome	隐藏标题栏上的返回小程序凯发k8官方网娱乐官方首页按钮。	✓	✓
my.gettitlecolor	获取导航栏背景色。	✓	✓
my.getmenubuttonboundingclientrect	获取菜单按钮（右上角胶囊按钮）的布局位置信息。	✓	✓
my.getleftbuttonsboundingclientrect	获取标题栏左侧按钮的布局位置信息。	✓	✓
my.shownavigationbarloading	在当前页面显示导航条的加载动画。	✓	✓
my.hidenavigationbarloading	在当前页面隐藏导航条的加载动画。	✓	✓

tabbar

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.showtabbar	显示 tabbar。	✓	✓
my.hidetabbar	隐藏 tabbar。	✓	✓
my.settabbaritem	动态设置 tabbar 某一项的文字、图标。	✓	✓
my.settabbarstyle	设置 tabbar 的样式。	✓	✓
my.settabbarbadge	为 tabbar 某一项的右上角添加文本。	✓	✓
my.removetabbarbadge	移除 tabbar 某一项右上角的文本。	✓	✓
my.showtabbarreddot	显示 tabbar 某一项的右上角的红点。	✓	✓
my.hidetabbarreddot	隐藏 tabbar 某一项的右上角的红点。	✓	✓

路由

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.switchtab	跳转到 tabbar 页面。	✓	✓
my.navigateto	保留当前页面，跳转到应用内的某个指定页面。	✓	✓
my.navigateback	关闭当前页面，返回上一级或多级页面。	✓	✓
my.redirectto	关闭当前页面，打开指定页面。	✓	✓
my.relaunch	关闭所有页面，跳转到应用内的某个指定页面。	✓	✓
eventchannel	页面间事件通信通道。	✓	✓

交互反馈

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.showloading	显示 loading 提示框。	✓	✓
my.hideloading	隐藏 loading 提示框。	✓	✓
my.showmodal	显示模态对话框。	✓	✓
my.alert	弹出警告框。	✓	✓
my.showtoast	显示弱提示。	✓	✓
my.hidetoast	隐藏弱提示。	✓	✓
my.showactionsheet	显示操作菜单。	✓	✓
my.confirm	显示提示确认框。	✓	✓
my.prompt	弹出对话框，接收用户文本输入。	✓	✓
my.enablealertbeforeunload	开启小程序页面返回询问对话框。	✓	✓
my.disablealertbeforeunload	关闭小程序页面返回询问对话框。	✓	✓

下拉刷新

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.startpulldownrefresh	开始下拉刷新。	✓	✓
my.stoppulldownrefresh	停止当前页面的下拉刷新。	✓	✓

联系人

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.choosephonecontact	选择系统通讯录中某个联系人。	✓	✓
my.choosealipaycontact	唤起支付宝通讯录，选择一个或者多个支付宝联系人。	✓	✓
my.choosecontact	拉起通讯录，选择联系人。	✓	✓

选择城市

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.choosecity	打开城市选择列表。	✓	✓
choosecitytask	监听定位完成事件，以便修改默认定位城市名称。	✓	✓
my.choosedistrict	地区选择器。	✓	✓
my.regionpicker	唤起多级省市区选择器，自带省市区数据源。	✓	✓
my.onlocatedcomplete	监听地理位置定位完成事件。	✓	✓
my.offlocatedcomplete	移除定位完成事件的监听函数。	✓	✓
my.setlocatedcity	设置 my.choosecity 中定位城市的名称。	✓	✓

选择日期

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.datepicker	打开日期或时间选择列表。	✓	✓

动画

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.createanimation	创建动画实例。	✓	✓

画布

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
canvas	canvas 实例。	✓	✓
image	图片对象，可用于在 canvas 中绘制图片。	✓	✓
canvasrenderingcontext2d	canvasrenderingcontext2d 绘图上下文。	✓	✓
canvaspattern	canvaspattern 由 canvasrenderingcontext2d.createpattern() 方法创建的图案，可用于设置 canvasrenderingcontext2d.fillstyle 或 canvasrenderingcontext2d.strokestyle。	✓	✓
imagedata	用于描述一个矩形区域内的像素信息。	✓	✓
offscreencanvas	离屏 canvas 实例，可通过 my.createoffscreencanvas 创建。	✓	✓

地图

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getmapinfo	获取地图基础信息。	✓	✓
my.createmapcontext	创建并返回一个 map 上下文对象 mapcontext 。	✓	✓
mapcontext	mapcontext 实例，可通过 my.createmapcontext 获取。	✓	✓

计算路径

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.calculateroute	计算路径。根据起点和终点的地理位置，智能规划最佳出行路线，并计算不同出行方式下的行动距离和所需时间，默认规划步行路线，支持规划步行、公交、骑行和驾车四种路线。	✓	✓

键盘

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.hidekeyboard	隐藏键盘。	✓	✓

滚动

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.pagescrollto	将页面滚动到目标位置。	✓	✓

节点查询

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.createselectorquery	获取一个节点查询对象 selectorquery。	✓	✓
my.createintersectionobserver	创建并返回一个 intersectionobserver 对象实例。	✓	✓
selectorquery	节点查询对象类。	✓	✓
intersectionobserver	intersectionobserver 对象，用于推断某些节点是否可以被用户看见、有多大比例可以被用户看见。	✓	✓
mediaqueryobserver	mediaqueryobserver 对象，用于监听页面 media query 状态的变化，如界面的长宽是不是在某个指定的范围内。	✓	✓

选项选择器

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.optionsselect	用于唤起 select 选择器，支持单列选择和双列数据选择。	✓	✓

级联选择

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.multilevelselect	级联选择器。主要使用在于多级关联数据选择。	✓	✓

设置窗口背景

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.setbackgroundcolor	动态设置窗口的背景色。	✓	✓
my.setbackgroundtextstyle	动态设置下拉背景字体、loading 图的样式。	✓	✓

设置页面是否支持下拉

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.setcanpulldown	设置页面是否支持下拉。	✓	✓

字体

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.loadfontface	动态加载网络字体。	✓	✓

跳转

小程序相互跳转

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.navigatetominiprogram	跳转到其它小程序。	✓	✓
my.navigatebackminiprogram	跳转回上一个小程序，只有当另一个小程序跳转到当前小程序时才能调用成功。	✓	✓

跳转支付宝应用或页面

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.ap.openalipayapp	打开支付宝客户端内指定的应用。	✓	✓
my.ap.openurl	打开 url。	✗	✓

重启/退出小程序

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.restartminiprogram	重启当前小程序。	✓	✓
my.exitminiprogram	退出当前小程序。必须有点击行为才能调用成功。	✓	✓

多媒体

图片

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.chooseimage	从本地相册选择图片或使用相机拍照。	✓	✓
my.previewimage	预览图片。	✓	✓
my.getimageinfo	获取图片信息。	✓	✓
my.saveimagetophotosalbum	保存图片到系统相册。	✓	✓
my.compressimage	压缩图片。	✓	✓
my.generateimagefromcode	生成二维码图片。	✓	✓

视频

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.choosevideo	从本地相册选择视频或使用相机摄像。	✓	✓
my.getvideoinfo	获取视频的详细信息。	✓	✓
my.savevideotophotosalbum	保存视频到系统相册。	✓	✓
my.createvideocontext	创建 video 组件上下文 videocontext 对象。	✓	✓
videocontext	videocontext 由 my.createvideocontext 创建，用于操作对应的 video 组件。	✓	✓

音频

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.createinneraudiocontext	创建前景（前台）音频管理器。	✓	✓
inneraudiocontext	全局唯一的前景（内部）音频管理器，可通过 my.createinneraudiocontext 获取。	✓	✓
my.getbackgroundaudiomanager	获取背景（后台）音频管理器。	✓	✓
backgroundaudiomanager	全局唯一的背景（后台）音频管理器，可通过 my.getbackgroundaudiomanager 获取。	✓	✓
my.onaudiointerruptionbegin	监听音频因为系统占用而被中断的开始事件。	✓	✓
my.offaudiointerruptionbegin	取消监听音频因为系统占用而被中断的开始事件。	✓	✓
my.onaudiointerruptionend	监听音频因为系统占用而被中断结束事件。	✓	✓
my.offaudiointerruptionend	取消监听音频因为系统占用而被中断结束事件。	✓	✓

录音

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getrecordermanager	获取全局唯一的录音管理器 recordermanager。	✓	✓
recordermanager	全局唯一的录音管理器，可通过 my.getrecordermanager 获取。	✓	✓
my.getavailableaudiosources	获取当前可用的音频输入源。	✓	✓

lottie 动画

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.createlottiecontext	lottie 是一个用于 web 和 ios 的移动库，可使用 bodymovin 解析以 json 格式导出的 adobe after effects 动画，并将其本地呈现在移动设备上。 my.createlottiecontext 用于创建并返回一个 lottieid 上下文对象 lottiecontext。	✓	✓
lottiecontext	由 my.createlottiecontext 创建，用于操作对应的 lottie 组件。	✓	✓

相机

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.createcameracontext	创建 camera 上下文 cameracontext 对象。	✓	✓
cameracontext	用于操作对应的 camera 组件。	✓	✓
cameraframelistener	cameracontext.oncameraframe 返回的监听器。	✓	✓

缓存

数据存储

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.setstorage	将数据存储在本地缓存中指定的 key 中。	✓	✓
my.setstoragesync	将数据同步存储在本地缓存中指定的 key 中。	✓	✓
my.getstorage	从本地缓存中异步获取指定 key 的内容。	✓	✓
my.getstoragesync	从本地缓存中同步获取指定 key 的内容。	✓	✓
my.getstorageinfo	异步获取数据缓存相关信息。	✓	✓
my.getstorageinfosync	获取数据缓存相关信息的同步接口。	✓	✓
my.removestorage	从本地缓存中异步删除指定 key。	✓	✓
my.removestoragesync	从本地缓存中同步删除指定 key。	✓	✓
my.clearstorage	异步清除本地数据缓存。	✓	✓
my.clearstoragesync	同步清除本地数据缓存。	✓	✓

预拉取

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getbackgroundfetchdata	拉取 backgroundfetch 客户端缓存数据。具体可查看数据预拉取。	✓	✓

文件

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.opendocument	预览本地文件。支持 pdf 及 office 文件格式。	✓	✓
my.savefiletodisk	保存小程序本地文件到系统存储空间。	✓	✓
my.detectfiletype	检测文件类型。	✓	✓
my.getfilesystemmanager	获取全局唯一的文件管理器。	✓	✓
filesystemmanager	filesystemmanager 文件管理器，可通过 my.getfilesystemmanager 获取。	✓	✓
stats	描述文件状态的对象。	✓	✓

位置

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getlocation	获取用户所处地理位置。	✓	✓
my.ap.getmainselectedcity	获取用户在支付宝凯发k8官方网娱乐官方首页左上角所选城市的信息。	✗	✓
my.chooselocation	使用支付宝内置地图选择地理位置。	✓	✓
my.openlocation	使用支付宝内置地图显示指定经纬度位置。	✓	✓

网络

发起请求

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.request	发起https网络请求。	✓	✓
requesttask	my.request 返回的对象，可用于获取 http 响应头，以及取消请求任务。	✓	✓

上传

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.uploadfile	上传本地文件到开发者服务器。	✓	✓
uploadtask	my.uploadfile 返回的对象，用于获取 http 响应头，监听上传进度变化，以及取消上传任务。	✓	✓

下载

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.downloadfile	下载文件到本地。	✓	✓
downloadtask	my.downloadfile 返回的对象，可用获取 http 响应头，监听下载进度变化，以及取消下载任务。	✓	✓

websocket

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.connectsocket	创建连接。	✓	✓
my.closesocket	关闭 websocket 连接。	✓	✓
my.sendsocketmessage	通过 websocket 连接发送数据。	✓	✓
my.onsocketopen	监听 websocket 连接打开事件。	✓	✓
my.offsocketopen	取消监听 websocket 连接打开事件。	✓	✓
my.onsocketmessage	监听 websocket 接受到服务器的消息事件。	✓	✓
my.offsocketmessage	取消监听 websocket 接受到服务器的消息事件。	✓	✓
my.onsocketerror	监听 websocket 错误事件。	✓	✓
my.offsocketerror	取消监听 websocket 错误事件。	✓	✓
my.onsocketclose	监听 websocket 连接关闭事件。	✓	✓
my.offsocketclose	取消监听 websocket 连接关闭事件。	✓	✓
sockettask	websocket 任务。	✓	✓

设备

系统信息

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getsysteminfo	获取手机系统信息。	✓	✓
my.getsysteminfosync	获取手机系统信息的同步接口。	✓	✓
my.getdevicebaseinfo	获取设备基础信息。	✓	✓
my.getsystemsetting	获取系统设置。	✓	✓
my.getwindowinfo	获取窗口信息。	✓	✓
my.getappbaseinfo	获取支付宝客户端基础信息。	✓	✓
my.getappauthorizesetting	获取支付宝 app 授权设置。	✓	✓

网络状态

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getnetworktype	获取当前网络状态。	✓	✓
my.onnetworkstatuschange	监听网络状态变化事件。	✓	✓
my.offnetworkstatuschange	移除网络状态变化事件的监听函数。	✓	✓

截屏

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.setvisualeffectoncapture	设置截屏/录屏时屏幕表现。，仅支持在 android 端调用。	✓	✓

剪切板

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getclipboard	获取剪贴板数据。	✗	✓
my.setclipboard	设置剪贴板内容。	✗	✓

摇一摇

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.watchshake	监听手机摇一摇。	✓	✓

振动

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.vibrate	触发设备振动。	✓	✓
my.vibratelong	触发设备长时间 (400 ms) 振动。	✓	✓
my.vibrateshort	触发设备较短时间 (40 ms) 振动。	✓	✓

加速度计

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.startaccelerometer	开始接收加速度计数据。	✓	✓
my.stopaccelerometer	停止接收加速度计数据。	✓	✓
my.onaccelerometerchange	监听加速度计数据变化。	✓	✓
my.offaccelerometerchange	移除加速计数据变化监听函数。	✓	✓

陀螺仪

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.startgyroscope	开始监听陀螺仪数据。	✓	✓
my.stopgyroscope	停止监听陀螺仪数据。	✓	✓
my.ongyroscopechange	监听陀螺仪数据变化。	✓	✓
my.offgyroscopechange	移除陀螺仪数据变化监听函数。	✓	✓

罗盘

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.startcompass	开始监听罗盘数据。	✓	✓
my.stopcompass	停止监听罗盘数据。	✓	✓
my.oncompasschange	添加罗盘数据变化事件的监听函数。	✓	✓
my.offcompasschange	移除罗盘数据变化事件监听函数。	✓	✓

设备方向

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.startdevicemotionlistening	开始监听设备方向变化。	✓	✓
my.stopdevicemotionlistening	停止监听设备方向变化。	✓	✓
my.ondevicemotionchange	监听设备方向变化。	✓	✓
my.offdevicemotionchange	移除设备方向变化事件的监听函数。	✓	✓

拨打电话

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.makephonecall	拨打电话。	✓	✓

获取服务器时间

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getservertime	获取支付宝服务器的当前时间（距 1970-01-01 00:00:00（utc）的毫秒数）。	✓	✓

用户截屏事件

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.onusercapturescreen	监听用户发起的主动截屏事件。	✓	✓
my.offusercapturescreen	移除用户截屏事件的监听函数。	✓	✓

屏幕亮度

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getscreenbrightness	获取屏幕亮度。	✓	✓
my.setscreenbrightness	设置屏幕亮度。	✓	✓
my.setkeepscreenon	设置是否保持屏幕常亮。	✓	✓

设置

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getsetting	获取用户对当前小程序的授权状态。	✓	✓
my.opensetting	打开小程序设置界面，返回用户权限设置的结果。	✓	✓

添加手机联系人

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.addphonecontact	添加手机联系人。	✓	✓

无障碍

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.isscreenreaderenabled	获取设备是否开启视觉无障碍模式。	✓	✓

权限引导

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.showauthguide	弹出图文提示对话框，引导用户打开并授予支付宝指定权限。	✓	✓

扫码

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.scan	调起客户端扫码界面进行扫码。	✓	✓

内存不足告警

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.onmemorywarning	监听内存不足告警事件。	✓	✓
my.offmemorywarning	移除内存不足告警事件的监听函数。	✓	✓

获取设备电量

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getbatteryinfo	异步获取当前设备的电量和充电状态。	✗	✓
my.getbatteryinfosync	同步获取当前设备的电量和充电状态。	✗	✓

蓝牙

低功耗蓝牙

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.onbleconnectionstatechanged	监听低功耗蓝牙连接状态改变事件。	✓	✓
my.offbleconnectionstatechanged	取消监听低功耗蓝牙连接状态变化事件。	✓	✓
my.getbledeviceservices	获取指定低功耗蓝牙设备所有服务列表。	✓	✓
my.connectbledevice	连接低功耗蓝牙设备。	✓	✓
my.disconnectbledevice	断开与低功耗蓝牙设备的连接。	✓	✓
my.getbledevicecharacteristics	获取低功耗蓝牙设备某个服务中所有特征（characteristic）。	✓	✓
my.setblemtu	设置低功耗蓝牙设备最大传输单元（mtu）。需在 my.connectbledevice 调用成功后调用，mtu 设置范围（22, 512）。	✗	✓
my.getblemtu	获取低功耗蓝牙设备的最大传输单元（mtu）。	✗	✓
my.notifyblecharacteristicvaluechange	启用低功耗蓝牙设备特征值变化时的通知功能。	✓	✓
my.onblecharacteristicvaluechange	监听低功耗蓝牙设备的特征值变化的事件。	✓	✓
my.offblecharacteristicvaluechange	取消监听低功耗蓝牙设备的特征值变化的事件。	✓	✓
my.writeblecharacteristicvalue	向低功耗蓝牙设备特征值中写入数据。	✓	✓
my.readblecharacteristicvalue	读取低功耗蓝牙设备特征值中的数据。	✓	✓
my.getbledevicerssi	获取低功耗蓝牙设备的信号强度（received signal strength indication, rssi）。	✗	✓
my.getbledevicestatus	获取低功耗蓝牙设备授权及开关状态。	✗	✓

传统蓝牙

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.openbluetoothadapter	初始化蓝牙适配器。	✓	✓
my.closebluetoothadapter	断开所有已建立的蓝牙连接，并释放系统资源。	✓	✓
my.getbluetoothadapterstate	获取本机蓝牙模块状态。	✓	✓
my.onbluetoothadapterstatechange	监听本机蓝牙状态变化的事件。	✓	✓
my.offbluetoothadapterstatechange	移除本机蓝牙状态变化的事件的监听。	✓	✓
my.onbluetoothdevicefound	监听搜索到新蓝牙设备的事件。	✓	✓
my.offbluetoothdevicefound	移除搜索到蓝牙设备事件的监听函数。	✓	✓
my.startbluetoothdevicesdiscovery	开始搜索附近的蓝牙外围设备。	✓	✓
my.stopbluetoothdevicesdiscovery	停止搜寻附近的蓝牙外围设备。	✓	✓
my.getbluetoothdevices	获取所有已发现的蓝牙设备，包括已经和本机处于连接状态的设备。	✓	✓
my.getconnectedbluetoothdevices	获取已连接的设备。	✓	✓
my.makebluetoothpair	蓝牙配对。	✓	✓
my.getbluetoothpairs	获取已经配对的蓝牙设备。	✓	✓
my.cancelbluetoothpair	解除蓝牙配对。	✓	✓

ibeacon

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getbeacons	获取所有已经搜索到的 ibeacon 设备。	✓	✓
my.startbeacondiscovery	开始搜索附近的 ibeacon 设备。	✓	✓
my.stopbeacondiscovery	停止搜索附近的 ibeacon 设备。	✓	✓
my.onbeaconupdate	监听 ibeacon 设备的更新事件。	✓	✓
my.offbeaconupdate	取消监听 ibeacon 设备的更新事件。	✓	✓
my.onbeaconservicechange	监听 ibeacon 服务的状态变化。	✓	✓
my.offbeaconservicechange	取消监听 ibeacon 服务的状态变化。	✓	✓

wi-fi

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.startwifi	初始化 wi-fi 模块。	✗	✓
my.stopwifi	关闭 wi-fi 模块。	✗	✓
my.connectwifi	连接 wi-fi。	✗	✓
my.getwifilist	请求获取 wi-fi 列表。	✗	✓
my.onwificonnected	监听连接上 wi-fi 的事件。	✗	✓
my.offwificonnected	关闭监听连接上 wi-fi 的事件。	✗	✓
my.ongetwifilist	监听获取到 wi-fi 列表数据事件。	✗	✓
my.offgetwifilist	关闭监听获取到 wi-fi 列表数据的事件。	✗	✓
my.getconnectedwifi	获取已连接中的 wi-fi 信息。	✗	✓

短信

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.sendsms	拉起手机发送短信界面。	✓	✓

worker

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.createworker	创建一个 worker 线程。	✗	✓
worker	worker 实例。	✗	✓

数据安全

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.rsa	提供 rsa 加解密能力。	✓	✓

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.showsharepanel	唤起支付宝分享面板。	✓	✓
my.hidesharemenu	隐藏当前页面分享按钮。	✓	✓
my.showsharemenu	显示当前页面的分享按钮，被 my.hidesharemenu 置灰的分享按钮变为可点击状态。	✓	✓

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.iscollected	查询当前小程序是否被收藏。	✓	✓

自定义通用菜单

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.hideaddtodesktopmenu	禁用当前页面通用菜单中添加到桌面功能。	✓	✓
my.hidealladdtodesktopmenu	禁用所有页面通用菜单中添加到桌面功能。	✓	✓

更新管理

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getupdatemanager	创建一个 updatemanager 对象，获取全局唯一的版本更新管理器，用于管理小程序更新。	✓	✓
updatemanager	updatemanager 对象，用来管理更新，可通过 my.getupdatemanager 接口获取实例。	✓	✓

web-view 组件控制

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.createwebviewcontext	通过创建webviewcontext提供从小程序向web-view发送消息的能力。创建并返回 web-view 上下文 webviewcontext 对象。	✗	✓

升级支付宝最新版本

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.ap.updatealipayclient	打开支付宝客户端升级界面。	✓	✓

隐私信息授权

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.requireprivacyauthorize	模拟隐私接口调用，并触发隐私弹窗逻辑。	✓	✓
my.openprivacycontract	跳转至隐私协议页面。	✓	✓
my.onneedprivacyauthorization	监听隐私接口需要用户授权事件。	✓	✓
my.getprivacysetting	查询隐私授权情况。	✓	✓

开放能力 api

了解支付宝小程序开发流程，学习开放能力快速接入方式及提效工具，可报名参加支付宝官方实训营

。

支付

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.tradepay	小程序唤起支付。	✗	✓

用户授权

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getauthcode	获取用户信息授权，取得授权码（authcode）。	✓	✓
用户授权指引	所有支付宝开放平台的读、写用户信息，均需要经过用户的许可才允许开发者使用，用户授权基于国际标准的 oauth2.0 授权机制，基于此机制开发者可以获取支付宝用户信息、给用户发会员卡等。	-	-

会员

获取会员基础信息

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getopenuserinfo	获取支付宝会员的基础信息。	✓	✓

获取会员收货地址

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getaddress	获取用户收货地址。	✗	✓

获取会员手机号

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getphonenumber	获取支付宝用户绑定的手机号。	✗	✓

周期扣款

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.paysigncenter	唤起周期扣款签约页面。	✗	✓

商家会员卡

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.opencardlist	跳转到支付宝卡包中的会员卡列表页。	✗	✓
my.opencarddetail	打开当前用户的某张商家会员卡的详情页。	✗	✓
my.openmerchantcardlist	打开当前用户的某个商户的卡列表。	✗	✓
my.openmerchantcard	开通会员卡。	✗	✓

消息

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.requestsubscribemessage	唤起客户端小程序消息订阅界面。	✓	✓
my.unsubscribemessage	取消当前用户已订阅的消息。	✓	✓

模板配置

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.getextconfigsync	获取小程序模板自定义数据字段的同步接口。	✗	✓
my.getextconfig	获取小程序模板自定义数据字段的异步接口。	✗	✓

支付宝卡包

券

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.openvoucherlist	打开支付宝卡包并显示优惠券列表。	✗	✓
my.openmerchantvoucherlist	打开支付宝卡包里指定商户的券列表。	✗	✓
my.openvoucherdetail	打开当前用户领取某张券的详情页（非口碑券）。	✗	✓
my.openkbvoucherdetail	打开支付宝卡包里的口碑券详情页。	✗	✓

票

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.openticketlist	打开支付宝卡包中的票列表。	✗	✓
my.openmerchantticketlist	打开支付宝卡包里指定商户的票列表。	✗	✓
my.openticketdetail	打开当前用户领取某张票的详情页。	✗	✓

交易组件

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.checkbeforeaddorder	适用于接入小程序交易组件的小程序在创建订单前进行调用。	✓	✓

小程序商品

名称	功能说明	支持个人支付宝小程序	支持企业支付宝小程序
my.ap.prepareusecertificate	本地生活商品凭证核销准备。	✓	✓