• 下载
  • 社区

API 概览

小程序


名称

功能说明

my.getAppIdSync

同步获取小程序 appId。

my.offAppHide

取消监听小程序切后台事件。

my.offAppShow

取消监听小程序切前台事件。

my.onAppHide

监听小程序切后台事件。

my.onAppShow

监听小程序切前台事件。


界面

导航栏

名称

功能说明

my.getTitleColor

获取导航栏背景色。

my.hideBackHome

隐藏 TitleBar 上的返回首页图标,和通用菜单中的返回首页功能

my.hideNavigationBarLoading

在当前页面隐藏导航条加载动画。

my.setNavigationBar

设置导航栏文字及样式。

my.showNavigationBarLoading

在当前页面显示导航条加载动画。

TabBar

名称

功能说明

my.hideTabBar

隐藏 tabBar。

my.hideTabBarRedDot

隐藏 tabBar 某一项的右上角的红点。

my.removeTabBarBadge

移除 tabBar 某一项右上角的文本。

my.setTabBarBadge

为 tabBar 某一项的右上角添加文本。

my.setTabBarItem

动态设置 tabBar 某一项的内容。

my.setTabBarStyle

动态设置 tabBar 的整体样式。

my.showTabBar

显示 tabBar。

my.showTabBarRedDot

显示 tabBar 某一项的右上角的红点。

onTabItemTap

点击 tab 时触发。

TabBar 常见问题

对 TabBar 标签的常见问题解答。

路由

名称

功能说明

my.switchTab

跳转到指定 tabBar 页面,并关闭其他所有非 tabBar 页面。

my.reLaunch

关闭当前所有页面,跳转到应用内的某个指定页面。

my.redirectTo

关闭当前页面,跳转到应用内的某个指定页面。

my.navigateTo

当前页面,跳转到应用内的某个指定页面,以使用 my.navigateBack 返回到原来页面。

my.navigateBack

关闭当前页面,返回上一级或多级页面。

路由 FAQ

对路由的常见问题解答。


交互反馈

名称

功能说明

my.alert

警告框。
my.confirm

确认框。

my.prompt

弹出一个对话框,让用户在对话框内输入文本。

my.showToast

显示一个弱提示,可选择多少秒之后消失。

my.hideLoading

隐藏加载提示。

my.hideToast

隐藏弱提示。

my.showLoading

显示加载提示。

my.showActionSheet

显示操作菜单。


下拉刷新

名称

功能说明

onPullDownRefresh

监听该页面用户的下拉刷新事件。

my.stopPullDownRefresh

停止当前页面的下拉刷新。

my.startPullDownRefresh

开始下拉刷新。

联系人

名称

功能说明

my.choosePhoneContact

选择本地系统通信录中某个联系人的电话。

my.chooseAlipayContact

唤起支付宝通讯录,选择一个或者多个支付宝联系人。

my.chooseContact

唤起选择联系人组件。

选择城市

名称

功能说明

my.chooseCity

打开城市选择列表。

选择日期

名称

功能说明

my.datePicker

打开日期选择列表。

动画

名称

功能说明

my.createAnimation

创建动画实例。

画布

名称

功能说明

my.createCanvasContext

创建 canvas 绘图上下文。

地图

名称

功能说明

my.createMapContext

创建并返回一个 map 上下文对象 mapContext。

键盘

名称

功能说明

my.hideKeyboard

隐藏键盘。

滚动

名称

功能说明

my.pageScrollTo

滚动到页面的目标位置。

节点查询

名称

功能说明

my.createIntersectionObserver

创建并返回一个 IntersectionObserver 对象实例

my.createSelectorQuery

获取一个节点查询对象 SelectorQuery。

选项选择器

名称

功能说明

my.optionsSelect

类似于 safari 原生 select 的组件,但是功能更加强大,一般用来替代 select,或者 2 级数据的选择。注意不支持 2 级数据之间的联动。

级联选择

名称

功能说明

my.multiLevelSelect

级联选择功能,主要使用在于多级关联数据选择。

设置窗口背景

名称

功能说明

my.setBackgroundColor

动态设置窗口的背景色。

my.setBackgroundTextStyle

动态设置下拉背景字体、loading 图的样式。

设置页面是否支持下拉

名称

功能说明

my.setCanPullDown

设置页面是否支持下拉。

设置 optionMenu

名称

功能说明

my.setOptionMenu

配置 optionMenu 导航栏额外图标,点击后触发 onOptionMenuClick。

字体

名称

功能说明

my.loadFontFace

动态加载网络字体。


多媒体

图片

名称

功能说明

my.chooseImage

拍照或从手机相册中选择图片。

my.previewImage

预览图片。

my.saveImage

保存在线图片到手机相册。

my.compressImage

压缩图片。

my.getImageInfo

获取图片信息。

缓存

名称

功能说明

my.setStorage

将数据存储在本地缓存中指定的 key 中的异步接口。

my.setStorageSync

同步将数据存储在本地缓存中指定的 key 中的同步接口。

my.getStorage

获取缓存数据的异步接口。

my.getStorageSync

获取缓存数据的同步接口。

my.removeStorage

删除缓存数据的异步接口。

my.removeStorageSync

删除缓存数据的同步接口。

my.clearStorage

清除本地数据缓存的异步接口。

my.clearStorageSync

清除本地数据缓存的同步接口。

my.getStorageInfo

获取当前 storage 的相关信息的异步接口。

my.getStorageInfoSync

获取当前 storage 相关信息的同步接口。

文件

基础文件管理

名称

功能说明

my.saveFile

保存文件到本地。

my.getFileInfo

获取文件信息。

my.getSavedFileInfo

获取保存的文件信息。

my.getSavedFileList

获取保存的所有文件信息。

my.removeSavedFile

删除某个保存的文件。

my.openDocument

在新页面打开文件预览,暂时只支持预览 PDF 格式文件。

位置

名称

功能说明

my.getLocation

获取用户当前的地理位置信息。

my.openLocation

使用支付宝内置地图查看位置。

my.chooseLocation

使用支付宝内置地图选择地理位置。

网络

名称

功能说明

my.request

小程序网络请求。

my.uploadFile

上传本地资源到开发者服务器。

my.downloadFile

下载文件资源到本地。

my.connectSocket

创建一个 WebSocket 的连接。

my.onSocketOpen

监听 WebSocket 连接打开事件。

my.offSocketOpen

取消监听 WebSocket 连接打开事件。

my.onSocketError

监听 WebSocket 错误。

my.offSocketError

取消监听 WebSocket 错误。

my.sendSocketMessage

通过 WebSocket 连接发送数据。

my.onSocketMessage

监听 WebSocket 接受到服务器的消息事件。

my.offSocketMessage

取消监听 WebSocket 接受到服务器的消息事件。

my.closeSocket

关闭 WebSocket 连接。

my.onSocketClose

监听 WebSocket 关闭。

my.offSocketClose

取消监听WebSocket关闭。

设备

 

canIUse

名称

功能说明

my.canIUse

判断当前小程序的 API、入参或返回值、组件、属性等在当前版本是否支持。

获取基础库版本号

名称

功能说明

my.SDKVersion

获取基础库版本号。

系统信息

名称

功能说明

my.getSystemInfo

获取手机系统信息。

my.getSystemInfoSync

获取手机系统信息的同步接口。

网络状态

名称

功能说明

my.getNetworkType

获取当前网络状态。

my.onNetworkStatusChange

开始网络状态变化的监听。

my.offNetworkStatusChange

取消网络状态变化的监听。

剪贴板

名称

功能说明

my.getClipboard

获取剪贴板数据。

my.setClipboard

设置剪贴板数据。

摇一摇

名称

功能说明

my.watchShake

摇一摇功能。

振动

名称

功能说明

my.vibrate

调用振动功能。

my.vibrateLong

较长时间的振动 (400ms)。

my.vibrateShort

较短时间的振动 (40ms)。

加速度计

名称

功能说明

my.onAccelerometerChange

监听加速度数据。

my.offAccelerometerChange

停止监听加速度数据。

陀螺仪

名称

功能说明

my.onGyroscopeChange

监听陀螺仪数据变化事件。

my.offGyroscopeChange

停止监听陀螺仪数据。

罗盘

名称

功能说明

my.onCompassChange

监听罗盘数据。

my.offCompassChange

停止监听罗盘数据。

拨打电话

名称

功能说明

my.makePhoneCall

拨打电话。

获取服务器时间

名称

功能说明

my.getServerTime

获取当前服务器时间的毫秒数。

用户截屏事件

名称

功能说明

my.onUserCaptureScreen

监听用户发起的主动截屏事件。

my.offUserCaptureScreen

取消监听截屏事件。

屏幕亮度

名称

功能说明

my.setKeepScreenOn

设置是否保持屏幕长亮状态。

my.getScreenBrightness

获取屏幕亮度。

my.setScreenBrightness

设置屏幕亮度。

设置

名称

功能说明

my.openSetting

打开小程序设置界面,返回用户权限设置的结果。

my.getSetting

获取用户的当前设置。

添加手机联系人

名称

功能说明

my.addPhoneContact

用户可以选择将该表单以“创建新联系人”或“添加到现有联系人”的方式,写入到手机系统的通讯录。

权限引导

名称

功能说明

my.showAuthGuide

通过权限引导模块以图文等形式向用户弹出 Dialog,引导用户打开相应的权限。

扫码

名称

功能说明

my.scan

调用扫一扫功能。

内存不足告警

名称

功能说明

my.onMemoryWarning

开始监听内存不足的告警事件。

my.offMemoryWarning

停止监听内存不足的告警事件。

获取设备电量

名称

功能说明

my.getBatteryInfo

获取电量的异步接口。

my.getBatteryInfoSync

获取电量的同步接口。

蓝牙


低功耗蓝牙

名称

功能说明

my.connectBLEDevice

连接低功耗蓝牙设备。

my.disconnectBLEDevice

断开与低功耗蓝牙设备的连接。

my.writeBLECharacteristicValue

向低功耗蓝牙设备特征值中写入数据。

my.readBLECharacteristicValue

读取低功耗蓝牙设备特征值中的数据。

my.notifyBLECharacteristicValueChange

启用低功耗蓝牙设备特征值变化时的 notify 功能。

my.getBLEDeviceServices

获取蓝牙设备所有 service(服务)。

my.getBLEDeviceCharacteristics

获取蓝牙设备所有 characteristic(特征值)。

my.onBLECharacteristicValueChange

监听低功耗蓝牙设备的特征值变化的事件。

my.offBLECharacteristicValueChange

监听低功耗蓝牙设备的特征值变化的事件。

my.onBLEConnectionStateChanged

监听低功耗蓝牙连接的错误事件,包括设备丢失,连接异常断开等。

my.offBLEConnectionStateChanged

取消低功耗蓝牙连接状态变化事件的监听。

传统蓝牙

名称功能说明
my.openBluetoothAdapter

初始化小程序蓝牙模块。

my.closeBluetoothAdapter关闭本机蓝牙模块。
my.getBluetoothAdapterState

获取本机蓝牙模块状态。

my.startBluetoothDevicesDiscovery获取本机蓝牙模块状态。
my.stopBluetoothDevicesDiscovery

停止搜寻附近的蓝牙外围设备。

my.getBluetoothDevices

获取所有已发现的蓝牙设备,包括已经和本机处于连接状态的设备。

my.getConnectedBluetoothDevices

获取处于已连接状态的设备。

my.onBluetoothDeviceFound

搜索到新的蓝牙设备时触发此事件。

my.offBluetoothDeviceFound

移除寻找到新的蓝牙设备事件的监听。

my.onBluetoothAdapterStateChange

监听本机蓝牙状态变化的事件。

my.offBluetoothAdapterStateChange

移除本机蓝牙状态变化的事件的监听。


iBeacon

名称

功能说明

my.startBeaconDiscovery

开始搜索附近的 iBeacon 设备。

my.stopBeaconDiscovery

停止搜索附近的 iBeacon 设备。

my.getBeacons

获取已经搜索到的 iBeacon 设备。

my.onBeaconUpdate

监听 iBeacon 设备的更新事件。

my.onBeaconServiceChange

监听 iBeacon 服务的状态变化。

数据安全

名称

功能说明

my.rsa

非对称加密。


分享

名称

功能说明

onShareAppMessage

在 Page 中定义 onShareAppMessage 函数,设置该页面的分享信息。

my.hideShareMenu

隐藏分享按钮。

my.showSharePanel

唤起分享面板。


收藏

名称

功能说明

my.isCollected

查询当前小程序是否被收藏。


自定义通用菜单

名称功能说明
my.hideShareMenu

隐藏当前页面右上角通用菜单中的 分享 功能。

my.hideAddToDesktopMenu

隐藏当前页面通用菜单中的 添加到桌面 功能。

my.hideAllAddToDesktopMenu

隐藏所有页面的通用菜单中的 添加到桌面 功能。

my.hideFavoriteMenu

隐藏当前页面的通用菜单中的 收藏 按钮。

my.hideAllFavoriteMenu

隐藏所有页面的通用菜单中的 收藏 功能。


小程序当前运行版本类型

名称

功能说明

my.getRunScene

用于获取当前小程序的运行版本。


自定义分析

名称

功能说明

my.reportAnalytics

自定义分析数据的上报接口。


更新管理

名称

功能说明

my.getUpdateManager

创建一个 UpdateManager 对象,获取全局唯一的版本更新管理器,用于管理小程序更新。

UpdateManager

UpdateManager 对象,用来管理更新,可通过 my.getUpdateManager 接口获取实例。

web-view组件控制

名称

功能说明

my.createWebViewContext

通过创建webviewContext提供从小程序向web-view发送消息的能力。创建并返回 web-view 上下文 webViewContext 对象。


跳转支付宝应用或页面

名称

功能说明

my.ap.navigateToAlipayPage

小程序中跳转到支付宝官方业务或运营活动页面。


升级支付宝最新版本

名称

功能说明

my.ap.updateAlipayClient

打开支付宝客户端升级界面。


开放能力 API

基础能力

能力名称

能力简述

API名称

功能说明

小程序二维码

开发者获取生成小程序二维码的能力,将生成后小程序二维码在线下进行贴码推广。

alipay.open.app.qrcode.create

生成小程序推广二维码

小程序相互跳转

开发者在小程序内通过开放接口,让用户跳转到任一一个小程序。

my.navigateToMiniProgram

跳转到其他小程序。

小程序跳转 FAQ

对小程序跳转的常见问题解答。



用户授权

开发者通过此功能来获取用户的授权和允许,获取用户的基本信息。

my.getAuthCode

获取用户授权码。

用户授权 FAQ

对用户授权的常见问题解答。




支付能力

能力名称

能力简述

API名称

功能说明

小程序支付

用户在小程序内调起支付宝收银台付款。

my.tradePay

小程序唤起支付。

小程序支付 / 资金授权 FAQ

小程序支付 / 资金授权的常见问题解答。




资金能力

能力名称

能力简述

API名称

功能说明

资金授权

用户在小程序开启服务时需要做一笔资金授权,当服务完结算时,再从授权资金中扣除消费金额,剩余返还给用户。

my.tradePay

小程序支付接口。

小程序支付 / 资金授权 FAQ

小程序支付 / 资金授权的常见问题解答。




会员能力

能力名称

能力简述

API名称

功能说明

获取会员基础信息

小程序开发者在获得用户授权后,可通过接口获取用户头像、昵称、性别、所在地区等基础信息。

my.getAuthCode

用户授权获取授权code。注意在此注册流程中,scopes参数请传递“auth_base”。

my.getOpenUserInfo

获取会员基础信息。

获取会员基础信息 FAQ

获取会员基础信息的常见问题解答。



获取会员手机号

开发者在自己的小程序中经用户授权后,快速获取支付宝会员手机号信息,用于与自身平台的账户绑定、进行精准营销。

my.getPhoneNumber

获取会员手机号码。

获取会员手机号 FAQ

获取会员手机号的常见问题解答。



获取会员收货地址

支付宝开放平台在充分告知用户、并得到用户授权的情况下,允许商户/开发者获取用户指定的收货地址信息。

my.getAddress

获取会员收货地址。

商户会员卡

帮助商家建立会员体系,开拓精准营销。

my.addCardAuth

小程序内唤起开卡页面。

my.openCardList

打开支付宝卡包中的“卡”列表。

my.openMerchantCardList

打开当前用户领取某个商户的“卡”列表。

my.openCardDetail

打开当前用户领取某张卡的详情页。

人脸采集

人脸采集是在获得用户充分授权和认可,获取到符合质量要求的活体人脸图片,用于后续的对比、识别等操作。

my.ap.faceVerify

人脸采集。


营销能力

能力名称

能力简述

API名称

功能说明

支付宝卡包

支付宝卡包是支付宝公司推出的一款可以管理电子凭证的产品;该产品聚合来自各类生活服务的票据凭证,包括各类券和票等。

my.openVoucherList

打开支付宝卡包中的“卷”列表。

my.openMerchantVoucherList

打开当前用户领取某个商户的“卷”列表。

my.openVoucherDetail

打开当前用户领取某张卷的详情页(非口碑卷)。

my.openKBVoucherDetail

打开当前用户领取某张卷的详情页(口碑卷)。

my.openTicketList

打开支付宝卡包中的“票”列表。

my.openMerchantTicketList

打开当前用户领取某个商户的“票”列表。

my.openTicketDetail

打开当前用户领取某张票的详情页。

运动数据

借助运动数据功能,小程序在获得用户许可的情况下,可以获取用户最近 30 天内的运动步数,步数信息会在用户进入小程序时更新。

my.getRunData

获取步数。

模板消息

开发者可通过消息高效触达用户,通知用户当前行为的结果及状态等;同时可在消息中配置跳转小程序指定页面地址。

alipay.open.app.mini.templatemessage.send

小程序通过 OpenAPI 给用户触达消息,主要为支付后的触达(通过消费 id)和用户提交表单后的触达(通过formId)。

小程序自定义分享

小程序可以便捷地分享到支付宝客户端内和其他 APP 中,目前支持分享的渠道有:朋友动态、支付宝好友、钉钉、微博、微信、QQ。

onShareAppMessage

设置页面的分享信息。


安全能力

能力名称

能力简述

API名称

功能说明

先享后付保障

帮助商家避免用户使用了服务,但拒绝付款造成的货损风险。

my.ap.nsf

先享后付保障。

营销反作弊

有效识别刷单、恶意秒杀、恶意抢红包等行为,从而保障平台的营销资金不被黑产恶意套取。

my.ap.preventCheat

营销反作弊。

文本风险识别

帮助用户有效识别垃圾广告、恶意言论、黄赌毒、暴恐政等非法用户原创内容。

my.textRiskIdentification

文本风险识别(用户端)。

图片内容安全

帮助商户识别图片中夹杂的色情、违禁违法等垃圾图片,净化网络环境。

my.ap.imgRisk

图片提交接口。

my.ap.imgRiskCallback

风险结果查询接口。