# API 总览

- **当前最新版 多端 SDK（ 即 Android SDK >= 1.5 以及 iOS SDK >= 1.5.3 版本) 对齐小程序基础库的版本是 3.6.5；其余版本 SDK 对齐小程序基础库的版本是 3.2.5**
- 其他通用接口的接口文档可查看[小程序 API 文档中心](/miniprogram/dev/api/)，如果与小程序 API 有所区别的即可点击跳转对应接口文档
- 是否支持：指的是是否适用于多端框架；由于和小程序是同源 API，「否」表示的是只支持小程序环境中使用，不适用于多端框架使用
- 如果测试出现了不符合预期的情况，可先检查一下 SDK 是否已经是最新的，以及是否配置了扩展 SDK ，如自查依旧无法定位问题可前往[社区](https://developers.weixin.qq.com/community/develop/mixflow)进行反馈
- 如开发者的 App 中需使用到下方标记的尚未支持的 API，可前往[社区](https://developers.weixin.qq.com/community/develop/mixflow)进行反馈

图表中

是[1]: 表示支持，但 API 返回的内容和小程序的存在差异

否[1]: 表示不支持，原因是有替代方案

支持的类型

1. 支持，但 API 返回内容有差异
2. 支持，但交互行为存在差异
3. 支持，但停止维护

不支持的原因

1. 有其他替代方案
2. 尚未支持，后续会支持
3. 尚未支持，后续会支持，但是 API 含义会有差异 
4. 微信特有交互流程，后续不会支持
5. 已废弃，后续不会支持
6. 特定系统才有的 API，后续不会支持

补充：

- 点此查看[基础 SDK 包含的 JSAPI](../pre-read/sdk/sdk#_2-1-1-%E5%9F%BA%E7%A1%80-sdk-%E5%B7%B2%E7%BB%8F%E5%8C%85%E5%90%AB%E7%9A%84-jsapi-%E5%A6%82%E4%B8%8B)
- 点此查看[JSAPI 对应依赖的 扩展 SDK](../pre-read/sdk/sdk#_2-2-%E6%89%A9%E5%B1%95-sdk)

## 基础

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.env](/miniprogram/dev/api/base/wx.env.md) |环境变量 | 是 |
| [wx.canIUse](/miniprogram/dev/api/base/wx.canIUse.md) | 判断应用的 API，回调，参数，组件等是否在当前版本可用 |是 |
| [wx.base64ToArrayBuffer](/miniprogram/dev/api/base/wx.base64ToArrayBuffer.md) | 将 Base64 字符串转成 ArrayBuffer 对象 |是[3] |
| [wx.arrayBufferToBase64](/miniprogram/dev/api/base/wx.arrayBufferToBase64.md) | 将 ArrayBuffer 对象转成 Base64 字符串 |是[3] |

### 系统

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getSystemInfo](diffapi/getSystemInfo) | 获取系统信息 | 是[1] |
| [wx.openSystemBluetoothSetting](/miniprogram/dev/api/base/system/wx.openSystemBluetoothSetting.md) | 跳转系统蓝牙设置页 |否[2] |
| [wx.openAppAuthorizeSetting](/miniprogram/dev/api/base/system/wx.openAppAuthorizeSetting.md) | 跳转系统授权管理页 |是 |
| [wx.getAppAuthorizeSetting](/miniprogram/dev/api/base/system/wx.getAppAuthorizeSetting.md) | 获取 App 授权设置 | 是 |
| [wx.getWindowInfo](/miniprogram/dev/api/base/system/wx.getWindowInfo.md) | 获取窗口信息 |是 |
| [wx.getSystemSetting](/miniprogram/dev/api/base/system/wx.getSystemSetting.md) | 获取设备设置 |是 |
| [wx.getSystemInfoSync](diffapi/getSystemInfo) | wx.getSystemInfo 的同步版本 |  是[1] |
| [wx.getSystemInfoAsync](diffapi/getSystemInfo) | 异步获取系统信息 |   是[1] |
| [wx.getDeviceInfo](/miniprogram/dev/api/base/system/wx.getDeviceInfo.md) | 获取设备基础信息 |是 |
| [wx.getAppBaseInfo](diffapi/getAppBaseInfo) | 获取 App 基础信息 |  是[1]  |

### 更新

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.updateWeChatApp](/miniprogram/dev/api/base/update/wx.updateWeChatApp.md)  | 更新客户端版本| 否[4] |
| [wx.getUpdateManager](/miniprogram/dev/api/base/update/wx.getUpdateManager.md) | 获取全局唯一的版本更新管理器，用于管理小程序更新 |是，[查看使用要求](/miniprogram/dev/platform-capabilities/miniapp/handbook/web/publish)  |

### 生命周期
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getLaunchOptionsSync](diffapi/getLaunchOptionsSync) | 获取应用启动时的参数 | 是[1] |
| [wx.getEnterOptionsSync](diffapi/getEnterOptionsSync) | 获取本次应用启动时的参数 | 是[1] |

### 应用级事件

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.onUnhandledRejection](/miniprogram/dev/api/base/app/app-event/wx.onUnhandledRejection.md) | 监听未处理的 Promise 拒绝事件 |是 |
| [wx.onThemeChange](/miniprogram/dev/api/base/app/app-event/wx.onThemeChange.md) | 监听系统主题改变事件 |是 |
| [wx.onPageNotFound](/miniprogram/dev/api/base/app/app-event/wx.onPageNotFound.md) | 监听应用要打开的页面不存在事件 |是 |
| [wx.onLazyLoadError](/miniprogram/dev/api/base/app/app-event/wx.onLazyLoadError.md) | 监听应用异步组件加载失败回调 |是 |
| [wx.onError](/miniprogram/dev/api/base/app/app-event/wx.onError.md) | 监听应用错误事件 |是 |
| [wx.onAudioInterruptionEnd](/miniprogram/dev/api/base/app/app-event/wx.onAudioInterruptionEnd.md)| 监听音频中断结束事件 |是 |
| [wx.onAudioInterruptionBegin](/miniprogram/dev/api/base/app/app-event/wx.onAudioInterruptionBegin.md) | 监听音频因为受到系统占用而被中断开始事件 |是 |
| [wx.onAppShow](/miniprogram/dev/api/base/app/app-event/wx.onAppShow.md) | 应用切前台事件 |是 |
| [wx.onAppHide](/miniprogram/dev/api/base/app/app-event/wx.onAppHide.md) | 监听应用切后台事件 |是 |
| [wx.offUnhandledRejection](/miniprogram/dev/api/base/app/app-event/wx.offUnhandledRejection.md)| 取消监听未处理的 Promise 拒绝事件 |是 |
| [wx.offThemeChange](/miniprogram/dev/api/base/app/app-event/wx.offThemeChange.md) | 取消监听系统主题改变事件 |是 |
| [wx.offPageNotFound](/miniprogram/dev/api/base/app/app-event/wx.offPageNotFound.md) | 取消监听应用要打开的页面不存在事件 |是 |
| [wx.offLazyLoadError](/miniprogram/dev/api/base/app/app-event/wx.offLazyLoadError.md) | 取消监听应用异步组件加载失败回调 |是 |
| [wx.offError](/miniprogram/dev/api/base/app/app-event/wx.offError.md) | 取消监听应用错误事件 |是 |
| [wx.offAudioInterruptionEnd](/miniprogram/dev/api/base/app/app-event/wx.offAudioInterruptionEnd.md)| 取消监听音频中断结束事件 |是 |
| [wx.offAudioInterruptionBegin](/miniprogram/dev/api/base/app/app-event/wx.offAudioInterruptionBegin.md) | 取消监听音频因为受到系统占用而被中断开始事件 |是 |
| [wx.offAppShow](/miniprogram/dev/api/base/app/app-event/wx.offAppShow.md) | 取消监听应用切前台事件 |是 |
| [wx.offAppHide](/miniprogram/dev/api/base/app/app-event/wx.offAppHide.md) | 取消监听应用切后台事件 |是 |

### 调试

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- | 
| [wx.setEnableDebug](/miniprogram/dev/api/base/debug/wx.setEnableDebug.md) | 设置是否打开调试开关 |是 |  
| [wx.getRealtimeLogManager](/miniprogram/dev/api/base/debug/wx.getRealtimeLogManager.md) | 获取实时日志管理器对象 |是[2]，但日志只在本地生效，尚未有系统可以查询 |
| [wx.getLogManager](/miniprogram/dev/api/base/debug/wx.getLogManager.md) | 获取日志管理器对象 | 是[2]，但日志只在本地生效，尚未有系统可以查询|

### 性能

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.reportPerformance](/miniprogram/dev/api/base/performance/wx.reportPerformance.md)  | 小程序测速上报| 否[2] |
| [wx.preloadWebview](/miniprogram/dev/api/base/performance/wx.preloadWebview.md)  | 预加载下个页面的 WebView| 否[2] |
| [wx.preloadSkylineView](/miniprogram/dev/api/base/performance/wx.preloadSkylineView.md)  | 预加载下个页面所需要的 Skyline 运行环境| 否[2] |
| [wx.preloadAssets](/miniprogram/dev/api/base/performance/wx.preloadAssets.md)  | 为视图层预加载媒体资源文件, 目前支持：font，image| 否[2] |
| [wx.getPerformance](/miniprogram/dev/api/base/performance/wx.getPerformance.md) | 获取当前应用性能相关的信息 |是|

### 加密
| 名称 | 功能说明 |是否支持 | 
| -- | -- |-- |
| [wx.getUserCryptoManager](/miniprogram/dev/api/base/crypto/wx.getUserCryptoManager.md) | 获取用户加密模块 | 否[1]，可使用[微信网关](/miniprogram/security/gateway/README.md)替代|

## 路由

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.switchTab](/miniprogram/dev/api/route/wx.switchTab.md) | 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面 |是|
| [wx.reLaunch](/miniprogram/dev/api/route/wx.reLaunch.md)  | 关闭所有页面，打开到应用内的某个页面 |是|
| [wx.redirectTo](/miniprogram/dev/api/route/wx.redirectTo.md)  | 关闭当前页面，跳转到应用内的某个页面 |是|
| [wx.navigateTo](/miniprogram/dev/api/route/wx.navigateTo.md)  | 保留当前页面，跳转到应用内的某个页面 |是|
| [wx.navigateBack](/miniprogram/dev/api/route/wx.navigateBack.md)  | 关闭当前页面，返回上一页面或多级页面 |是|

### EventChannel

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [EventChannel.emit](/miniprogram/dev/api/route/EventChannel.emit.md) | 触发一个事件 |是|
| [EventChannel.off](/miniprogram/dev/api/route/EventChannel.off.md)  | 取消监听一个事件 |是|
| [EventChannel.on](/miniprogram/dev/api/route/EventChannel.on.md)  | 持续监听一个事件 |是|
| [EventChannel.once](/miniprogram/dev/api/route/EventChannel.once.md)  | 监听一个事件一次，触发后失效 |是|

## 跳转

- wx.navigateToMiniProgram 不支持，开发者可使用新接口 [wx.miniapp.launchMiniProgram](miniapp/launchMiniProgram) 实现

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.openEmbeddedMiniProgram](/miniprogram/dev/api/navigate/wx.openEmbeddedMiniProgram.md)  | 打开半屏小程序 | 否[4] |
| [wx.navigateToMiniProgram](/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.md)  | 打开另一个小程序 |否[4] |
| [wx.navigateBackMiniProgram](/miniprogram/dev/api/navigate/wx.navigateBackMiniProgram.md)  | 返回到上一个小程序 |否[4] |
| [wx.exitMiniProgram](/miniprogram/dev/api/navigate/wx.exitMiniProgram.md) | 退出当前小程序 |否[4] |

## 转发

- 可以通过新接口实现分享到微信的功能，详情可查看
[wx.miniapp.shareImageMessage](miniapp/shareImageMessage)、
[wx.miniapp.shareMiniProgramMessage](miniapp/shareMiniProgramMessage)、
[wx.miniapp.shareTextMessage](miniapp/shareTextMessage)、
[wx.miniapp.shareWebPageMessage](miniapp/shareWebPageMessage)、
[wx.miniapp.shareVideoMessage](miniapp/shareVideoMessage)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.updateShareMenu](/miniprogram/dev/api/share/wx.updateShareMenu.md)  | 更新转发属性 | 否[4]  |
| [wx.showShareMenu](/miniprogram/dev/api/share/wx.showShareMenu.md)  | 显示当前页面的转发按钮 | 否[4] |
| [wx.showShareImageMenu](/miniprogram/dev/api/share/wx.showShareImageMenu.md)  | 打开分享图片弹窗，可以将图片发送给朋友、收藏或下载 | 否[4]  |
| [wx.shareVideoMessage](/miniprogram/dev/api/share/wx.shareVideoMessage.md)  | 转发视频到聊天 | 否[1] | 
| [wx.shareFileMessage](/miniprogram/dev/api/share/wx.shareFileMessage.md)  | 转发文件到聊天 |否[1] |
| [wx.onCopyUrl](/miniprogram/dev/api/share/wx.onCopyUrl.md)  | 监听用户点击右上角菜单的「复制链接」按钮时触发的事件 |否[4]|
| [wx.offCopyUrl](/miniprogram/dev/api/share/wx.updateShareMenu.md)  | 移除用户点击右上角菜单的「复制链接」按钮时触发的事件的监听函数 |否[4]|
| [wx.hideShareMenu](/miniprogram/dev/api/share/wx.hideShareMenu.md)  | 隐藏当前页面的转发按钮 |否[4]|
| [wx.getShareInfo](/miniprogram/dev/api/share/wx.getShareInfo.md)  | 获取转发详细信息 |否[4]|
| [wx.authPrivateMessage](/miniprogram/dev/api/share/wx.authPrivateMessage.md)  | 验证私密消息 |否[4]|

## 界面

### 交互

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.showToast](/miniprogram/dev/api/ui/interaction/wx.showToast.md)| 显示消息提示框 |是|
| [wx.showModal](/miniprogram/dev/api/ui/interaction/wx.showModal.md) | 显示模态对话框 |是|
| [wx.showLoading](/miniprogram/dev/api/ui/interaction/wx.showLoading.md) | 显示 loading 提示框 |是|
| [wx.showActionSheet](/miniprogram/dev/api/ui/interaction/wx.showActionSheet.md) | 显示操作菜单 |是|
| [wx.hideToast](/miniprogram/dev/api/ui/interaction/wx.hideToast.md) | 隐藏消息提示框 |是|
| [wx.hideLoading](/miniprogram/dev/api/ui/interaction/wx.hideLoading.md) | 隐藏 loading 提示框 |是|
| [wx.enableAlertBeforeUnload](/miniprogram/dev/api/ui/interaction/wx.enableAlertBeforeUnload.md) | 开启应用页面返回询问对话框 |是|
| [wx.disableAlertBeforeUnload](/miniprogram/dev/api/ui/interaction/wx.disableAlertBeforeUnload.md) | 关闭应用页面返回询问对话框 |是|

### 导航栏

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.showNavigationBarLoading](/miniprogram/dev/api/ui/navigation-bar/wx.showNavigationBarLoading.md) | 在当前页面显示导航条加载动画 |是|
| [wx.setNavigationBarTitle](/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarTitle.md) | 动态设置当前页面的标题 |是|
| [wx.setNavigationBarColor](/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarColor.md) | 设置页面导航条颜色 |是|
| [wx.hideNavigationBarLoading](/miniprogram/dev/api/ui/navigation-bar/wx.hideNavigationBarLoading.md)| 在当前页面隐藏导航条加载动画 |是|
| [wx.hideHomeButton](/miniprogram/dev/api/ui/navigation-bar/wx.hideHomeButton.md) | 隐藏返回首页按钮 |是|

### 背景

| 名称 | 功能说明 |是否支持 |
| -- | -- | -- | 
| [wx.setBackgroundTextStyle](/miniprogram/dev/api/ui/background/wx.setBackgroundTextStyle.md) | 动态设置下拉背景字体、loading 图的样式 |是|
| [wx.setBackgroundColor](/miniprogram/dev/api/ui/background/wx.setBackgroundTextStyle.md)  | 动态设置窗口的背景色 |是|

### Tab Bar

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.showTabBarRedDot](/miniprogram/dev/api/ui/tab-bar/wx.showTabBarRedDot.md) | 显示 tabBar 某一项的右上角的红点 |是|
| [wx.showTabBar](/miniprogram/dev/api/ui/tab-bar/wx.showTabBar.md)  | 显示 tabBar |是|
| [wx.setTabBarStyle](/miniprogram/dev/api/ui/tab-bar/wx.setTabBarStyle.md) | 动态设置 tabBar 的整体样式 |是|
| [wx.setTabBarItem](/miniprogram/dev/api/ui/tab-bar/wx.setTabBarItem.md)  | 动态设置 tabBar 某一项的内容，`2.7.0` 起图片支持临时文件和网络文件 |是|
| [wx.setTabBarBadge](/miniprogram/dev/api/ui/tab-bar/wx.setTabBarBadge.md) | 为 tabBar 某一项的右上角添加文本 |是|
| [wx.removeTabBarBadge](/miniprogram/dev/api/ui/tab-bar/wx.removeTabBarBadge.md)  | 移除 tabBar 某一项右上角的文本 |是|
| [wx.hideTabBarRedDot](/miniprogram/dev/api/ui/tab-bar/wx.hideTabBarRedDot.md) | 隐藏 tabBar 某一项的右上角的红点 |是|
| [wx.hideTabBar](/miniprogram/dev/api/ui/tab-bar/wx.hideTabBar.md)  | 隐藏 tabBar |

### 字体

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.loadFontFace](/miniprogram/dev/api/ui/font/wx.loadFontFace.md)| 动态加载网络字体，文件地址需为下载类型 |是|

### 下拉刷新

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopPullDownRefresh](/miniprogram/dev/api/ui/pull-down-refresh/wx.stopPullDownRefresh.md) | 停止当前页面下拉刷新 |是|
| [wx.startPullDownRefresh](/miniprogram/dev/api/ui/pull-down-refresh/wx.startPullDownRefresh.md)  | 开始下拉刷新 |是|

### 滚动

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.pageScrollTo](/miniprogram/dev/api/ui/scroll/wx.pageScrollTo.md) | 将页面滚动到目标位置，支持选择器和滚动距离两种方式定位 |是|

#### ScrollViewContext

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [ScrollViewContext.scrollIntoView](/miniprogram/dev/api/ui/scroll/ScrollViewContext.scrollIntoView.md)| 滚动至指定位置 |是|
| [ScrollViewContext.scrollTo](/miniprogram/dev/api/ui/scroll/ScrollViewContext.scrollTo.md) | 滚动至指定位置 |是|

### 动画

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createAnimation](/miniprogram/dev/api/ui/animation/wx.createAnimation.md) | 创建一个动画实例 [animation](/miniprogram/dev/api/ui/animation/Animation.md) 对象 |是|

### 置顶
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.setTopBarText](/miniprogram/dev/api/ui/sticky/wx.setTopBarText.md)| 动态设置置顶栏文字内容 |否[5]|

### 自定义组件

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.nextTick](/miniprogram/dev/api/ui/custom-component/wx.nextTick.md) | 延迟一部分操作到下一个时间片再执行 |是|

### 菜单

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- | 
| [wx.getMenuButtonBoundingClientRect](/miniprogram/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.md)  | 获取菜单按钮（右上角胶囊按钮）的布局位置信息 | 是[2], App 里不再呈现胶囊标识，该接口依旧返回相关坐标信息，便于开发者进行多端兼容| 

### 窗口

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.setWindowSize](/miniprogram/dev/api/ui/window/wx.setWindowSize.md)  | 设置窗口大小，该接口仅适用于 PC 平台| 否[6]|
| [wx.onWindowResize](/miniprogram/dev/api/ui/window/wx.onWindowResize.md) | 监听窗口尺寸变化事件 |否[6]|
| [wx.offWindowResize](/miniprogram/dev/api/ui/window/wx.offWindowResize.md)  | 移除窗口尺寸变化事件的监听函数 |否[6]|

### worklet 动画

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.worklet](/miniprogram/dev/api/ui/window/wx.setWindowSize.md)  | 获取 worklet 对象 |否[2]|

## 网络

### 发起请求

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.request](/miniprogram/dev/api/network/request/wx.request.md) | 发起 HTTPS 网络请求 |是|

### 下载

| 名称 | 功能说明 |是否支持 | 
| -- | -- |-- | 
| [wx.downloadFile](/miniprogram/dev/api/network/download/wx.downloadFile.md) | 下载文件资源到本地 |是[2]，下载允许的最大文件已调整为 2G |

### 上传

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.uploadFile](/miniprogram/dev/api/network/upload/wx.uploadFile.md) | 将本地资源上传到服务器 |是|

### WebSocket

- 下方 WebSocket 相关的 JSAPI 依赖扩展 SDK 「Network SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
- 注意：Android 和 iOS 的扩展 SDK 有所区别，详情查看 `project.miniapp.json` 

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.sendSocketMessage](/miniprogram/dev/api/network/websocket/wx.sendSocketMessage.md)  | 通过 WebSocket 连接发送数据 |是|
| [wx.onSocketOpen](/miniprogram/dev/api/network/websocket/wx.onSocketOpen.md)  | 监听 WebSocket 连接打开事件 |是|
| [wx.onSocketMessage](/miniprogram/dev/api/network/websocket/wx.onSocketMessage.md)  | 监听 WebSocket 接受到服务器的消息事件 |是|
| [wx.onSocketError](/miniprogram/dev/api/network/websocket/wx.onSocketError.md)  | 监听 WebSocket 错误事件 |是|
| [wx.onSocketClose](/miniprogram/dev/api/network/websocket/wx.onSocketClose.md)  | 监听 WebSocket 连接关闭事件 |是|
| [wx.connectSocket](/miniprogram/dev/api/network/websocket/wx.connectSocket.md)  | 创建一个 WebSocket 连接 |是|
| [wx.closeSocket](/miniprogram/dev/api/network/websocket/wx.closeSocket.md)  | 关闭 WebSocket 连接 |是|

### mDNS

- 下方 mDNS 相关的 JSAPI 依赖扩展 SDK 「Network SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
- 注意：Android 和 iOS 的扩展 SDK 有所区别，详情查看 `project.miniapp.json` 

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopLocalServiceDiscovery](/miniprogram/dev/api/network/mdns/wx.stopLocalServiceDiscovery.md)| 停止搜索 mDNS 服务 |是|
| [wx.startLocalServiceDiscovery](/miniprogram/dev/api/network/mdns/wx.startLocalServiceDiscovery.md)| 开始搜索局域网下的 mDNS 服务 |是|
| [wx.onLocalServiceResolveFail](/miniprogram/dev/api/network/mdns/wx.onLocalServiceResolveFail.md)| 监听 mDNS 服务解析失败的事件 |是|
| [wx.onLocalServiceLost](/miniprogram/dev/api/network/mdns/wx.onLocalServiceLost.md) | 监听 mDNS 服务离开的事件 |是|
| [wx.onLocalServiceFound](/miniprogram/dev/api/network/mdns/wx.onLocalServiceFound.md) | 监听 mDNS 服务发现的事件 |是|
| [wx.onLocalServiceDiscoveryStop](/miniprogram/dev/api/network/mdns/wx.onLocalServiceDiscoveryStop.md) | 监听 mDNS 服务停止搜索的事件 |是|
| [wx.offLocalServiceResolveFail](/miniprogram/dev/api/network/mdns/wx.offLocalServiceResolveFail.md)| 取消监听 mDNS 服务解析失败的事件 |是|
| [wx.offLocalServiceLost](/miniprogram/dev/api/network/mdns/wx.offLocalServiceLost.md) | 取消监听 mDNS 服务离开的事件 |是|
| [wx.offLocalServiceFound](/miniprogram/dev/api/network/mdns/wx.offLocalServiceFound.md)| 取消监听 mDNS 服务发现的事件 |是|
| [wx.offLocalServiceDiscoveryStop](/miniprogram/dev/api/network/mdns/wx.offLocalServiceDiscoveryStop.md)| 取消监听 mDNS 服务停止搜索的事件 |是|

### TCP 通信

- 下方 TCP 通信相关的 JSAPI 依赖扩展 SDK 「Network SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
- 注意：Android 和 iOS 的扩展 SDK 有所区别，详情查看 `project.miniapp.json` 

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createTCPSocket](/miniprogram/dev/api/network/tcp/wx.createTCPSocket.md)  | 创建一个 TCP Socket 实例 |支持|

### UDP 通信

- 下方 UDP 通信相关的 JSAPI 依赖扩展 SDK 「Network SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
- 注意：Android 和 iOS 的扩展 SDK 有所区别，详情查看 `project.miniapp.json` 

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createUDPSocket](/miniprogram/dev/api/network/udp/wx.createUDPSocket.md)  | 创建一个 UDP Socket 实例 |支持|

## 支付

- 需使用 [wx.miniapp.requestPayment](miniapp/requestPayment)
- iOS 的部分场景，需使用苹果内购 IAP（In-App Purchase），详情可查看[wx.miniapp.IAP](miniapp/IAP)
- 如果是 iOS ，则需要在项目中的 `project.miniapp.json` 配置勾选 「OpenFuns SDK（含支付）」这个扩展 SDK

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.requestPluginPayment](/miniprogram/dev/api/payment/wx.requestPluginPayment.md)  | 插件中发起支付 |否[1]|
| [wx.requestPayment](/miniprogram/dev/api/payment/wx.requestPayment.md)  | 发起微信支付 |否[1]|

## 监听 Scheme/UniversalLink 进入多端 App

- 需使用[wx.miniapp.registOpenURL](miniapp/registOpenURL)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.miniapp.registOpenURL](miniapp/registOpenURL)  | 监听通过 Scheme/UniversalLink 进入 App 的事件 | 是 |

## 数据缓存

- 多端应用模式下，wx.setStorage 的限制有所提升，单个 key 允许存储的最大数据长度为 100 MB，所有数据存储上限为 2G

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.setStorageSync](/miniprogram/dev/api/storage/wx.setStorageSync.md)  | 将数据存储在本地缓存中指定的 key 中 |支持|
| [wx.setStorage](/miniprogram/dev/api/storage/wx.setStorage.md)  | 将数据存储在本地缓存中指定的 key 中 |支持|
| [wx.revokeBufferURL](/miniprogram/dev/api/storage/wx.revokeBufferURL.md)  | 根据 URL 销毁存在内存中的数据 |支持|
| [wx.removeStorageSync](/miniprogram/dev/api/storage/wx.removeStorageSync.md)  | [wx.removeStorage](/miniprogram/dev/api/storage/wx.removeStorage.md) 的同步版本 |支持|
| [wx.removeStorage](/miniprogram/dev/api/storage/wx.removeStorage.md)  | 从本地缓存中移除指定 key |支持|
| [wx.getStorageSync](/miniprogram/dev/api/storage/wx.getStorageSync.md)  | 从本地缓存中同步获取指定 key 的内容 |支持|
| [wx.getStorageInfoSync](/miniprogram/dev/api/storage/wx.getStorageInfoSync.md)  | [wx.getStorageInfo](/miniprogram/dev/api/storage/wx.getStorageInfo.md) 的同步版本 |支持|
| [wx.getStorageInfo](/miniprogram/dev/api/storage/wx.getStorageInfo.md)  | 异步获取当前 storage 的相关信息 |支持|
| [wx.getStorage](/miniprogram/dev/api/storage/wx.getStorage.md)  | 从本地缓存中异步获取指定 key 的内容 |支持|
| [wx.createBufferURL](/miniprogram/dev/api/storage/wx.createBufferURL.md)  | 根据传入的 buffer 创建一个唯一的 URL 存在内存中 |支持|
| [wx.clearStorageSync](/miniprogram/dev/api/storage/wx.clearStorageSync.md)  | [wx.clearStorage](/miniprogram/dev/api/storage/wx.clearStorage.md) 的同步版本 |支持|
| [wx.clearStorage](/miniprogram/dev/api/storage/wx.clearStorage.md)  | 清理本地数据缓存 |支持|
| [wx.batchSetStorageSync](/miniprogram/dev/api/storage/wx.batchSetStorageSync.md)  | 将数据批量存储在本地缓存中指定的 key 中 |支持|
| [wx.batchSetStorage](/miniprogram/dev/api/storage/wx.batchSetStorage.md)  | 将数据批量存储在本地缓存中指定的 key 中 |支持|
| [wx.batchGetStorageSync](/miniprogram/dev/api/storage/wx.batchGetStorageSync.md)  | 从本地缓存中同步批量获取指定 key 的内容 |支持|
| [wx.batchGetStorage](/miniprogram/dev/api/storage/wx.batchGetStorage.md)  | 从本地缓存中异步批量获取指定 key 的内容 |支持|

### 周期性更新

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.setBackgroundFetchToken](/miniprogram/dev/api/storage/background-fetch/wx.setBackgroundFetchToken.md)  | 设置自定义登录态，在周期性拉取数据时带上，便于第三方服务器验证请求合法性 |否[2]|
| [wx.onBackgroundFetchData](/miniprogram/dev/api/storage/background-fetch/wx.onBackgroundFetchData.md)  | 监听收到 backgroundFetch 数据事件 |否[2]|
| [wx.getBackgroundFetchToken](/miniprogram/dev/api/storage/background-fetch/wx.getBackgroundFetchToken.md)  | 获取设置过的自定义登录态 |否[2]|
| [wx.getBackgroundFetchData](/miniprogram/dev/api/storage/background-fetch/wx.getBackgroundFetchData.md)  | 拉取 backgroundFetch 客户端缓存数据 |否[2]|

### 缓存管理器

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createCacheManager](/miniprogram/dev/api/storage/cachemanager/wx.createCacheManager.md)  | 创建缓存管理器 |否[2]|

## 数据分析

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.reportMonitor](/miniprogram/dev/api/data-analysis/wx.reportMonitor.md)  | 自定义业务数据监控上报接口 |否[2]|
| [wx.reportEvent](/miniprogram/dev/api/data-analysis/wx.reportEvent.md)  | 事件上报 |否[2]|
| [wx.reportAnalytics](/miniprogram/dev/api/data-analysis/wx.reportAnalytics.md)  | 自定义分析数据上报接口 |否[2]|
| [wx.getExptInfoSync](/miniprogram/dev/api/data-analysis/wx.getExptInfoSync.md)  | 给定实验参数数组，获取对应的实验参数值 |否[2]|

## 画布

- Android 端上使用 canvas 功能需要勾选  Xweb SDK ( XWeb SDK 或 XWeb Embed SDK 都可以)
- 可在开发者工具的 `project.miniapp.json` 中勾选上

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createOffscreenCanvas](/miniprogram/dev/api/canvas/wx.createOffscreenCanvas.md) | 创建离屏 canvas 实例 |是|
| [wx.createCanvasContext](/miniprogram/dev/api/canvas/wx.createCanvasContext.md)  | 创建 canvas 的绘图上下文 [CanvasContext](/miniprogram/dev/api/canvas/CanvasContext.md) 对象 |是|
| [wx.canvasToTempFilePath](/miniprogram/dev/api/canvas/wx.canvasToTempFilePath.md) | 把当前画布指定区域的内容导出生成指定大小的图片 |是|
| [wx.canvasPutImageData](/miniprogram/dev/api/canvas/wx.canvasPutImageData.md)  | 将像素数据绘制到画布 |是|
| [wx.canvasGetImageData](/miniprogram/dev/api/canvas/wx.canvasGetImageData.md)  | 获取 canvas 区域隐含的像素数据 |是|

## 媒体

### 地图

- 如下支持的地图相关接口能力，需配置 LBS SDK ，且需前往腾讯位置服务平台注册开发者账号并创建应用 Key，详情可查看[位置服务使用指南](/miniprogram/dev/platform-capabilities/miniapp/handbook/devtools/lbs)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createMapContext](/miniprogram/dev/api/media/map/wx.createMapContext.md) | 创建 [map](/miniprogram/dev/component/map.md)上下文 [MapContext](/miniprogram/dev/api/media/map/MapContext.md)对象 |是[2]|

#### MapContext

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [MapContext.addArc](/miniprogram/dev/api/media/map/MapContext.addArc.md) | 添加弧线，途经点与夹角必须设置一个 |是|
| [MapContext.addCustomLayer](/miniprogram/dev/api/media/map/MapContext.addCustomLayer.md)  | 添加个性化图层 |是|
| [MapContext.addGroundOverlay](/miniprogram/dev/api/media/map/MapContext.addGroundOverlay.md)  | 创建自定义图片图层，图片会随着地图缩放而缩放 |是|
| [MapContext.addMarkers](/miniprogram/dev/api/media/map/MapContext.addMarkers.md) | 添加 marker |是|
| [MapContext.addVisualLayer](/miniprogram/dev/api/media/map/MapContext.addVisualLayer.md)  | 添加可视化图层 |是|
| [MapContext.fromScreenLocation](/miniprogram/dev/api/media/map/MapContext.fromScreenLocation.md)  | 获取屏幕上的点对应的经纬度，坐标原点为地图左上角 |是|
| [MapContext.getCenterLocation](/miniprogram/dev/api/media/map/MapContext.getCenterLocation.md)  | 获取当前地图中心的经纬度 |是|
| [MapContext.getRegion](/miniprogram/dev/api/media/map/MapContext.getRegion.md)  | 获取当前地图的视野范围 |是|
| [MapContext.getRotate](/miniprogram/dev/api/media/map/MapContext.getRotate.md)  | 获取当前地图的旋转角 |是|
| [MapContext.getScale](/miniprogram/dev/api/media/map/MapContext.getScale.md)  | 获取当前地图的缩放级别 |是|
| [MapContext.getSkew](/miniprogram/dev/api/media/map/MapContext.getSkew.md)  | 获取当前地图的倾斜角 |是|
| [MapContext.includePoints](/miniprogram/dev/api/media/map/MapContext.includePoints.md)  | 缩放视野展示所有经纬度 |是|
| [MapContext.initMarkerCluster](/miniprogram/dev/api/media/map/MapContext.initMarkerCluster.md)  | 初始化点聚合的配置，未调用时采用默认配置 |是|
| [MapContext.moveAlong](/miniprogram/dev/api/media/map/MapContext.moveAlong.md)  | 沿指定路径移动 `marker`，用于轨迹回放等场景 |是|
| [MapContext.moveToLocation](/miniprogram/dev/api/media/map/MapContext.moveToLocation.md)  | 将地图中心移置当前定位点，此时需设置地图组件 show-location 为true |是|
| [MapContext.on](/miniprogram/dev/api/media/map/MapContext.on.md)  | 监听地图事件 |是|
| [MapContext.openMapApp](/miniprogram/dev/api/media/map/MapContext.openMapApp.md)  | 拉起地图 APP 选择导航 |否[2]|
| [MapContext.removeArc](/miniprogram/dev/api/media/map/MapContext.removeArc.md)  | 删除弧线 |是|
| [MapContext.removeCustomLayer](/miniprogram/dev/api/media/map/MapContext.removeCustomLayer.md)  | 移除个性化图层 |是|
| [MapContext.removeGroundOverlay](/miniprogram/dev/api/media/map/MapContext.removeGroundOverlay.md)  | 移除自定义图片图层 |是|
| [MapContext.removeMarkers](/miniprogram/dev/api/media/map/MapContext.removeMarkers.md)  | 移除 marker |是|
| [MapContext.removeVisualLayer](/miniprogram/dev/api/media/map/MapContext.removeVisualLayer.md) | 移除可视化图层 |是|
| [MapContext.setBoundary](/miniprogram/dev/api/media/map/MapContext.setBoundary.md) | 限制地图的显示范围 |是|
| [MapContext.setCenterOffset](/miniprogram/dev/api/media/map/MapContext.setCenterOffset.md)  | 设置地图中心点偏移，向后向下为增长，屏幕比例范围(0.25~0.75)，默认偏移为[0.5, 0.5] |是|
| [MapContext.setLocMarkerIcon](/miniprogram/dev/api/media/map/MapContext.setLocMarkerIcon.md)  | 设置定位点图标，支持网络路径、本地路径、代码包路径 |是|
| [MapContext.toScreenLocation](/miniprogram/dev/api/media/map/MapContext.toScreenLocation.md)  | 获取经纬度对应的屏幕坐标，坐标原点为地图左上角 |是|
| [MapContext.translateMarker](/miniprogram/dev/api/media/map/MapContext.translateMarker.md)  | 平移 marker，带动画 |是|
| [MapContext.updateGroundOverlay](/miniprogram/dev/api/media/map/MapContext.updateGroundOverlay.md)  | 更新自定义图片图层 |是|

### 图片

 - 图片、音视频、相机、相册、录音等多媒体相关 JSAPI 依赖扩展 SDK 「Media SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
 - 注意：在 iOS SDK >= 1.3.11 以及 开发者工具版本 >= 1.06.2405102，iOS Media SDK 已经被拆分为：Audio SDK、Video SDK、Image SDK、Camera SDK，开发者需按需勾选
 - wx.previewMedia：iOS SDK >= 1.5.2 且需勾选 Video SDK；Android SDK >= 1.5.9 且需勾选 media sdk

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.saveImageToPhotosAlbum](/miniprogram/dev/api/media/image/wx.saveImageToPhotosAlbum.md)  | 保存图片到系统相册 |是|
| [wx.previewMedia](diffapi/previewMedia)  | 预览图片和视频 |已支持，但参数有差异|
| [wx.previewImage](/miniprogram/dev/api/media/image/wx.previewImage.md)  | 在新页面中全屏预览图片 |是[2]，长按识别功能暂时还不支持|
| [wx.getImageInfo](/miniprogram/dev/api/media/image/wx.getImageInfo.md)  | 获取图片信息 |是|
| [wx.editImage](/miniprogram/dev/api/media/image/wx.editImage.md)  | 编辑图片接口 |否[2]|
| [wx.cropImage](/miniprogram/dev/api/media/image/wx.cropImage.md)  | 裁剪图片接口 |是，Android SDK >=1.5.6；iOS SDK >=1.5.12|
| [wx.compressImage](/miniprogram/dev/api/media/image/wx.compressImage.md)  | 压缩图片接口，可选压缩质量 |是|
| [wx.chooseMessageFile](/miniprogram/dev/api/media/image/wx.chooseMessageFile.md)  | 从客户端会话选择文件 |否[4]，可使用[wx.miniapp.chooseFile](miniapp/chooseFile)代替|
| [wx.chooseImage](/miniprogram/dev/api/media/image/wx.chooseImage.md)  | 从本地相册选择图片或使用相机拍照 |是，已不维护；建议使用wx.chooseMedia|

### 视频

 - 图片、音视频、相机、相册、录音等多媒体相关 JSAPI 依赖扩展 SDK 「Media SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
 - 注意：在 iOS SDK >= 1.3.11 以及 开发者工具版本 >= 1.06.2405102，iOS Media SDK 已经被拆分为：Audio SDK、Video SDK、Image SDK、Camera SDK，开发者需按需勾选
 - 补充：iOS 应用中，如果使用`wx.chooseMedia` 则必须勾选 Video SDK
 - wx.compressVideo：Android SDK >= 1.4.13；iOS SDK >= 1.5.4
 - wx.getVideoInfo：iOS SDK >= 1.5.4；

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.saveVideoToPhotosAlbum](/miniprogram/dev/api/media/video/wx.saveVideoToPhotosAlbum.md) | 保存视频到系统相册 |是|
| [wx.getVideoInfo](/miniprogram/dev/api/media/video/wx.getVideoInfo.md) | 获取视频详细信息 |是|
| [wx.createVideoContext](/miniprogram/dev/api/media/video/wx.createVideoContext.md)  | 创建 [video](/miniprogram/dev/component/video.md) 上下文 [VideoContext](/miniprogram/dev/api/media/video/VideoContext.md) 对象 |是|
| [wx.compressVideo](/miniprogram/dev/api/media/video/wx.compressVideo.md) | 压缩视频接口 |是|
| wx.openVideoEditor | 打开视频编辑器 |否，但是有对应的解决方案，详情可查看[donut-ugc-editor](https://cloud.tencent.com/document/product/584/118710)|
| [wx.chooseVideo](/miniprogram/dev/api/media/video/wx.chooseVideo.md) | 拍摄视频或从手机相册中选视频 |是|
| [wx.chooseMedia](diffapi/chooseMedia) | 拍摄或从手机相册中选择图片或视频（需查看接口文档进行权限配置方可使用） |是[2]|

### 音频
 - 图片、音视频、相机、相册、录音等多媒体相关 JSAPI 依赖扩展 SDK 「Media SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
 - 注意：在 iOS SDK >= 1.3.11 以及 开发者工具版本 >= 1.06.2405102，iOS Media SDK 已经被拆分为：Audio SDK、Video SDK、Image SDK、Camera SDK，开发者需按需勾选

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopVoice](/miniprogram/dev/api/media/audio/wx.stopVoice.md)  | 结束播放语音 |是|
| [wx.setInnerAudioOption](/miniprogram/dev/api/media/audio/wx.setInnerAudioOption.md)  | 设置 [InnerAudioContext](/miniprogram/dev/api/media/audio/InnerAudioContext.md) 的播放选项 |是|
| [wx.playVoice](/miniprogram/dev/api/media/audio/wx.playVoice.md)  | 开始播放语音 |是|
| [wx.pauseVoice](/miniprogram/dev/api/media/audio/wx.pauseVoice.md)  | 暂停正在播放的语音 |是|
| [wx.getAvailableAudioSources](/miniprogram/dev/api/media/audio/wx.getAvailableAudioSources.md)  | 获取当前支持的音频输入源 |是|
| [wx.createWebAudioContext](/miniprogram/dev/api/media/audio/wx.createWebAudioContext.md)  | 创建 [WebAudioContext](/miniprogram/dev/api/media/audio/WebAudioContext.md) |是|
| [wx.createMediaAudioPlayer](/miniprogram/dev/api/media/audio/wx.createMediaAudioPlayer.md)  | 创建媒体音频播放器对象 [MediaAudioPlayer](/miniprogram/dev/api/media/audio/MediaAudioPlayer.md) 对象，可用于播放视频解码器 [VideoDecoder](/miniprogram/dev/api/media/video-decoder/VideoDecoder.md) 输出的音频 |是|
| [wx.createInnerAudioContext](/miniprogram/dev/api/media/audio/wx.createInnerAudioContext.md)  | 创建内部 [audio](/miniprogram/dev/component/audio.md) 上下文 [InnerAudioContext](/miniprogram/dev/api/media/audio/InnerAudioContext.md) 对象 |是|
| [wx.createAudioContext](/miniprogram/dev/api/media/audio/wx.createAudioContext.md)  | 创建 [audio](/miniprogram/dev/component/audio.md) 上下文 [AudioContext](/miniprogram/dev/api/media/audio/AudioContext.md) 对象 |是|

### 背景音频
 - 图片、音视频、相机、相册、录音等多媒体相关 JSAPI 依赖扩展 SDK 「Media SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
 - 注意：在 iOS SDK >= 1.3.11 以及 开发者工具版本 >= 1.06.2405102，iOS Media SDK 已经被拆分为：Audio SDK、Video SDK、Image SDK、Camera SDK，开发者需按需勾选

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopBackgroundAudio](/miniprogram/dev/api/media/background-audio/wx.stopBackgroundAudio.md)  | 停止播放音乐 |是|
| [wx.seekBackgroundAudio](/miniprogram/dev/api/media/background-audio/wx.seekBackgroundAudio.md)  | 控制音乐播放进度 |是|
| [wx.playBackgroundAudio](/miniprogram/dev/api/media/background-audio/wx.playBackgroundAudio.md)  | 使用后台播放器播放音乐 |是|
| [wx.pauseBackgroundAudio](/miniprogram/dev/api/media/background-audio/wx.pauseBackgroundAudio.md)  | 暂停播放音乐 |是|
| [wx.onBackgroundAudioStop](/miniprogram/dev/api/media/background-audio/wx.onBackgroundAudioStop.md)  | 监听音乐停止事件 |是|
| [wx.onBackgroundAudioPlay](/miniprogram/dev/api/media/background-audio/wx.onBackgroundAudioPlay.md)  | 监听音乐播放事件 |是|
| [wx.onBackgroundAudioPause](/miniprogram/dev/api/media/background-audio/wx.onBackgroundAudioPause.md)  | 监听音乐暂停事件 |是|
| [wx.getBackgroundAudioPlayerState](/miniprogram/dev/api/media/background-audio/wx.getBackgroundAudioPlayerState.md)  | 获取后台音乐播放状态 |是|
| [wx.getBackgroundAudioManager](diffapi/getBackgroundAudioManager)  | 获取**全局唯一**的[背景音频管理器](/miniprogram/dev/api/media/background-audio/BackgroundAudioManager.md) |是|

### 实时音视频
 - 使用 live-player 和 live-pusher 组件需要勾选 「Live SDK」（如果开发者工具上没看到该扩展 SDK ，请将开发者工具升级到最新）
 - 且 Android SDK 需 ≥ 1.2.9 ； iOS SDK 需 >= 1.6.3
 - 以及 iOS 端使用「Live SDK」时，还需配置 LiveLicenseUrl 和 LiveLicenseKey,详细操作可查看[https://cloud.tencent.com/document/product/454/34750](https://cloud.tencent.com/document/product/454/34750),即该能力依赖腾讯云的 SDK ，需要按照文档进行配置
 ![](https://testchu-7gy8occc8dcc14c3-1304825656.tcloudbaseapp.com/img%2Fmelody%2F202503170957973.png)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createLivePusherContext](/miniprogram/dev/api/media/live/wx.createLivePusherContext.md)  | 创建 [live-pusher](/miniprogram/dev/component/live-pusher.md) 上下文 [LivePusherContext](/miniprogram/dev/api/media/live/LivePusherContext.md) 对象 |是|
| [wx.createLivePlayerContext](/miniprogram/dev/api/media/live/wx.createLivePlayerContext.md)  | 创建 [live-player](/miniprogram/dev/component/live-pusher.md) 上下文 [LivePlayerContext](/miniprogram/dev/api/media/live/LivePlayerContext.md) 对象 |是|

### 录音
 - 图片、音视频、相机、相册、录音等多媒体相关 JSAPI 依赖扩展 SDK 「Media SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 「Media SDK」 方可生效；
 - RecorderManager 相关接口还需要在 `project.miniapp.json` 配置下列权限方可生效
   - Android：「Android 权限描述配置」 -> 「允许应用程序录制音频」
   - iOS：「隐私信息访问许可描述」 -> 「麦克风」

 ![](https://testchu-7gy8occc8dcc14c3-1304825656.tcloudbaseapp.com/img%2Fmelody%2F%E4%BC%81%E4%B8%9A%E5%BE%AE%E4%BF%A1%E6%88%AA%E5%9B%BE_2b38bf09-fadd-4ef5-ba16-ebbac1187f21.png)

 ![](https://res.wx.qq.com/op_res/LbYQe0g9Ht0wgUr3Y6wWv8R3hgAND9QdpzHkof9nDa73xUvAZ_Lgh3iLmRYLg4QqLutr9gHPnGkfdANCPO6J-A)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopRecord](/miniprogram/dev/api/media/recorder/wx.stopRecord.md) | 停止录音 |是|
| [wx.startRecord](/miniprogram/dev/api/media/recorder/wx.startRecord.md) | 开始录音 |是|
| [wx.getRecorderManager](/miniprogram/dev/api/media/recorder/wx.getRecorderManager.md) | 获取**全局唯一**的录音管理器 [RecorderManager](/miniprogram/dev/api/media/recorder/RecorderManager.md) |是|

### 相机
 - 图片、音视频、相机、相册、录音等多媒体相关 JSAPI 依赖扩展 SDK 「Media SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createCameraContext](/miniprogram/dev/api/media/camera/wx.createCameraContext.md)  | 创建 [camera](/miniprogram/dev/component/camera.md) 上下文 [CameraContext](/miniprogram/dev/api/media/camera/CameraContext.md) 对象 |是|
### 富文本
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [EditorContext](/miniprogram/dev/api/media/editor/EditorContext.md)  | EditorContext 实例 |是|

#### EditorContext
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [EditorContext.blur](/miniprogram/dev/api/media/editor/EditorContext.blur.md)  | 编辑器失焦，同时收起键盘 |是|
| [EditorContext.clear](/miniprogram/dev/api/media/editor/EditorContext.clear.md)  | 清空编辑器内容 |是|
| [EditorContext.format](/miniprogram/dev/api/media/editor/EditorContext.format.md)  | 修改样式 |是|
| [EditorContext.getContents](/miniprogram/dev/api/media/editor/EditorContext.getContents.md)  | 获取编辑器内容 |是|
| [EditorContext.getSelectionText](/miniprogram/dev/api/media/editor/EditorContext.getSelectionText.md)  | 获取编辑器已选区域内的纯文本内容 |是|
| [EditorContext.insertDivider](/miniprogram/dev/api/media/editor/EditorContext.insertDivider.md)  | 插入分割线 |是|
| [EditorContext.insertImage](/miniprogram/dev/api/media/editor/EditorContext.insertImage.md)  | 插入图片 |是|
| [EditorContext.insertText](/miniprogram/dev/api/media/editor/EditorContext.insertText.md)  | 覆盖当前选区，设置一段文本 |是|
| [EditorContext.redo](/miniprogram/dev/api/media/editor/EditorContext.redo.md)  | 恢复 |是|
| [EditorContext.removeFormat](/miniprogram/dev/api/media/editor/EditorContext.removeFormat.md)  | 清除当前选区的样式 |是|
| [EditorContext.scrollIntoView](/miniprogram/dev/api/media/editor/EditorContext.scrollIntoView.md)  | 使得编辑器光标处滚动到窗口可视区域内 |是|
| [EditorContext.setContents](/miniprogram/dev/api/media/editor/EditorContext.setContents.md)| 初始化编辑器内容，html 和 delta 同时存在时仅 delta 生效 |是|
| [EditorContext.undo](/miniprogram/dev/api/media/editor/EditorContext.undo.md)  | 撤销 |是|

### 音视频合成
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createMediaContainer](/miniprogram/dev/api/media/video-processing/wx.createMediaContainer.md)  | 创建[音视频处理容器](/miniprogram/dev/api/media/video-processing/MediaContainer.md)，最终可将容器中的轨道合成一个视频 |否[2]|

### 实时语音
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.updateVoIPChatMuteConfig](/miniprogram/dev/api/media/voip/wx.updateVoIPChatMuteConfig.md)  | 更新实时语音静音设置 |否[4]|
| [wx.subscribeVoIPVideoMembers](/miniprogram/dev/api/media/voip/wx.subscribeVoIPVideoMembers.md)  | 订阅视频画面成员 |否[4]|
| [wx.setEnable1v1Chat](/miniprogram/dev/api/media/voip/wx.setEnable1v1Chat.md)  | 开启双人通话 |否[4]|
| [wx.onVoIPVideoMembersChanged](/miniprogram/dev/api/media/voip/wx.onVoIPVideoMembersChanged.md)  | 监听实时语音通话成员视频状态变化事件 |否[4]|
| [wx.onVoIPChatStateChanged](/miniprogram/dev/api/media/voip/wx.onVoIPChatStateChanged.md)  | 监听房间状态变化事件 |否[4]|
| [wx.onVoIPChatSpeakersChanged](/miniprogram/dev/api/media/voip/wx.onVoIPChatSpeakersChanged.md)  | 监听实时语音通话成员通话状态变化事件 |否[4]|
| [wx.onVoIPChatMembersChanged](/miniprogram/dev/api/media/voip/wx.onVoIPChatMembersChanged.md)  | 监听实时语音通话成员在线状态变化事件 |否[4]|
| [wx.onVoIPChatInterrupted](/miniprogram/dev/api/media/voip/wx.onVoIPChatInterrupted.md)  | 监听被动断开实时语音通话事件 |否[4]|
| [wx.offVoIPVideoMembersChanged](/miniprogram/dev/api/media/voip/wx.offVoIPVideoMembersChanged.md)  | 移除实时语音通话成员视频状态变化事件的监听函数 |否[4]|
| [wx.offVoIPChatStateChanged](/miniprogram/dev/api/media/voip/wx.offVoIPChatStateChanged.md)  | 移除房间状态变化事件的监听函数 |否[4]|
| [wx.offVoIPChatSpeakersChanged](/miniprogram/dev/api/media/voip/wx.offVoIPChatSpeakersChanged.md)  | 移除实时语音通话成员通话状态变化事件的监听函数 |否[4]|
| [wx.offVoIPChatMembersChanged](/miniprogram/dev/api/media/voip/wx.offVoIPChatMembersChanged.md)  | 移除实时语音通话成员在线状态变化事件的监听函数 |否[4]|
| [wx.offVoIPChatInterrupted](/miniprogram/dev/api/media/voip/wx.offVoIPChatInterrupted.md)  | 移除被动断开实时语音通话事件的监听函数 |否[4]|
| [wx.joinVoIPChat](/miniprogram/dev/api/media/voip/wx.joinVoIPChat.md)  | 加入 (创建) 实时语音通话 |否[4]|
| [wx.join1v1Chat](/miniprogram/dev/api/media/voip/wx.join1v1Chat.md)  | 加入（创建）双人通话 |否[4]|
| [wx.exitVoIPChat](/miniprogram/dev/api/media/voip/wx.exitVoIPChat.md)  | 退出（销毁）实时语音通话 |否[4]|

### 画面录制器
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createMediaRecorder](/miniprogram/dev/api/media/media-recorder/wx.createMediaRecorder.md)  | 创建 [WebGL 画面录制器](/miniprogram/dev/api/media/media-recorder/MediaRecorder.md)，可逐帧录制在 WebGL 上渲染的画面并导出视频文件 |否[2]|

### 视频解码器
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createVideoDecoder](/miniprogram/dev/api/media/video-decoder/wx.createVideoDecoder.md)  | 创建[视频解码器](/miniprogram/dev/api/media/video-decoder/VideoDecoder.md)，可逐帧获取解码后的数据 |否[2]|

## 位置

- 如下支持的位置相关接口能力，需配置 LBS SDK ，且需前往腾讯位置服务平台注册开发者账号并创建应用 Key，详情可查看[位置服务使用指南](/miniprogram/dev/platform-capabilities/miniapp/handbook/devtools/lbs)
- `wx.startLocationUpdateBackground` 在 iOS 应用中使用前，需前往 `project.miniapp.json` 开启 「Location updates of Background Modes」，并且还需要填写对应的隐私信息许可描述，如下图

![](https://testchu-7gy8occc8dcc14c3-1304825656.tcloudbaseapp.com/img%2Fmelody%2F202406221530022.png)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopLocationUpdate](/miniprogram/dev/api/location/wx.stopLocationUpdate.md)  | 关闭监听实时位置变化，前后台都停止消息接收 |是|
| [wx.startLocationUpdateBackground](/miniprogram/dev/api/location/wx.startLocationUpdateBackground.md)  | 开启小程序进入前后台时均接收位置消息，需引导用户开启[授权](/miniprogram/dev/framework/open-ability/authorize.md) |是|
| [wx.startLocationUpdate](/miniprogram/dev/api/location/wx.startLocationUpdate.md)  | 开启小程序进入前台时接收位置消息 |是|
| [wx.openLocation](/miniprogram/dev/api/location/wx.openLocation.md)  | 使用微信内置地图查看位置 |是|
| [wx.onLocationChangeError](/miniprogram/dev/api/location/wx.onLocationChangeError.md)  | 监听持续定位接口返回失败时触发 |是|
| [wx.onLocationChange](/miniprogram/dev/api/location/wx.onLocationChange.md)  | 监听实时地理位置变化事件，需结合 wx.startLocationUpdateBackground、wx.startLocationUpdate 使用 |是|
| [wx.offLocationChangeError](/miniprogram/dev/api/location/wx.offLocationChangeError.md)  | 移除持续定位接口返回失败时触发 |是|
| [wx.offLocationChange](/miniprogram/dev/api/location/wx.offLocationChange.md)  | 移除实时地理位置变化事件的监听函数 |是|
| [wx.getLocation](/miniprogram/dev/api/location/wx.getLocation.md)  | 获取当前的地理位置、速度 |是|
| [wx.getFuzzyLocation](/miniprogram/dev/api/location/wx.getFuzzyLocation.md)  | 获取当前的模糊地理位置 |否[2]|
| [wx.choosePoi](/miniprogram/dev/api/location/wx.choosePoi.md)  | 打开 POI 列表选择位置，支持模糊定位（精确到市）和精确定位混选 |否[2]|
| [wx.chooseLocation](/miniprogram/dev/api/location/wx.chooseLocation.md)  | 打开地图选择位置 |是[2]|

## 文件

wx.openDocument 补充说明

- 在 Android 端使用该接口实现在应用内部预览，需在 project.miniapp.json 中将 XWEB 扩展 SDK 勾上，并且 Android SDK 版本需大于或等于 1.4.10
- 此外该接口在 Android 端使用时新增入参 `openInternal` 用于控制是否应用内打开文件（仅当开启 xweb 时生效）；该值的枚举值为 `true` 和 `false`

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.saveFileToDisk](/miniprogram/dev/api/file/wx.saveFileToDisk.md)  | 保存文件系统的文件到用户磁盘，仅在 PC 端支持 |是|
| [wx.openDocument](/miniprogram/dev/api/file/wx.openDocument.md)  | 新开页面打开文档 |是|
| [wx.getFileSystemManager](/miniprogram/dev/api/file/wx.getFileSystemManager.md)  | 获取全局唯一的[文件管理器](/miniprogram/dev/api/file/FileSystemManager.md) |是|
| wx.saveFile  | 保存文件到本地。wx.saveFile 即将废弃，请使用 [wx.getFileSystemManager().saveFile](/miniprogram/dev/api/file/FileSystemManager.saveFile.md) |是|
| wx.removeSavedFile | 删除本地缓存文件。wx.removeSavedFile 即将废弃，请使用 [wx.getFileSystemManager().removeSavedFile](/miniprogram/dev/api/file/FileSystemManager.removeSavedFile.md) |是|
| wx.getSavedFileList | 获取该小程序下已保存的本地缓存文件列表。wx.getSavedFileList 即将废弃，请使用 [wx.getFileSystemManager().getSavedFileList](/miniprogram/dev/api/file/FileSystemManager.getSavedFileList.md) |是|
| wx.getSavedFileInfo  | 获取本地文件的文件信息。wx.getSavedFileInfo 即将废弃，请使用 [wx.getFileSystemManager().getFileInfo](/miniprogram/dev/api/file/FileSystemManager.getFileInfo.md)  |是|
| wx.getFileInfo  | 获取文件信息。wx.getFileInfo 即将废弃，请使用 [wx.getFileSystemManager().getFileInfo](/miniprogram/dev/api/file/FileSystemManager.getFileInfo.md) |是|

### 蓝牙-通用

- 蓝牙相关 JSAPI 依赖扩展 SDK 「Bluetooth SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；

- 系统要求，手机上需要开启地理位置权限后才可以搜索到蓝牙

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopBluetoothDevicesDiscovery](/miniprogram/dev/api/device/bluetooth/wx.stopBluetoothDevicesDiscovery.md)  | 停止搜寻附近的蓝牙外围设备 |是|
| [wx.startBluetoothDevicesDiscovery](/miniprogram/dev/api/device/bluetooth/wx.startBluetoothDevicesDiscovery.md)  | 开始搜寻附近的蓝牙外围设备 |是|
| [wx.openBluetoothAdapter](/miniprogram/dev/api/device/bluetooth/wx.openBluetoothAdapter.md)  | 初始化蓝牙模块 |是|
| [wx.onBluetoothDeviceFound](/miniprogram/dev/api/device/bluetooth/wx.onBluetoothDeviceFound.md)  | 监听搜索到新设备的事件 |是|
| [wx.onBluetoothAdapterStateChange](/miniprogram/dev/api/device/bluetooth/wx.onBluetoothAdapterStateChange.md)  | 监听蓝牙适配器状态变化事件 |是|
| [wx.offBluetoothDeviceFound](/miniprogram/dev/api/device/bluetooth/wx.offBluetoothDeviceFound.md)  | 移除搜索到新设备的事件的监听函数 |是|
| [wx.offBluetoothAdapterStateChange](/miniprogram/dev/api/device/bluetooth/wx.offBluetoothAdapterStateChange.md)  | 移除蓝牙适配器状态变化事件的监听函数 |是|
| [wx.makeBluetoothPair](/miniprogram/dev/api/device/bluetooth/wx.makeBluetoothPair.md)  | 蓝牙配对接口，仅安卓支持 |是|
| [wx.isBluetoothDevicePaired](/miniprogram/dev/api/device/bluetooth/wx.isBluetoothDevicePaired.md)  | 查询蓝牙设备是否配对，仅安卓支持 |是|
| [wx.getConnectedBluetoothDevices](/miniprogram/dev/api/device/bluetooth/wx.getConnectedBluetoothDevices.md)  | 根据主服务 UUID 获取已连接的蓝牙设备 |是|
| [wx.getBluetoothDevices](/miniprogram/dev/api/device/bluetooth/wx.getBluetoothDevices.md)  | 获取在蓝牙模块生效期间所有搜索到的蓝牙设备 |是|
| [wx.getBluetoothAdapterState](/miniprogram/dev/api/device/bluetooth/wx.getBluetoothAdapterState.md)  | 获取本机蓝牙适配器状态 |是|
| [wx.closeBluetoothAdapter](/miniprogram/dev/api/device/bluetooth/wx.closeBluetoothAdapter.md)  | 关闭蓝牙模块 |是|

### 蓝牙-低功耗中心设备
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.writeBLECharacteristicValue](/miniprogram/dev/api/device/bluetooth-ble/wx.writeBLECharacteristicValue.md)  | 向蓝牙低功耗设备特征值中写入二进制数据 |是|
| [wx.setBLEMTU](/miniprogram/dev/api/device/bluetooth-ble/wx.setBLEMTU.md)  | 协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU) |是|
| [wx.readBLECharacteristicValue](/miniprogram/dev/api/device/bluetooth-ble/wx.readBLECharacteristicValue.md)  | 读取蓝牙低功耗设备特征值的二进制数据 |是|
| [wx.onBLEMTUChange](/miniprogram/dev/api/device/bluetooth-ble/wx.onBLEMTUChange.md)  | 监听蓝牙低功耗的最大传输单元变化事件（仅安卓触发） |是|
| [wx.onBLEConnectionStateChange](/miniprogram/dev/api/device/bluetooth-ble/wx.onBLEConnectionStateChange.md)  | 监听蓝牙低功耗连接状态改变事件 |是|
| [wx.onBLECharacteristicValueChange](/miniprogram/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.md)  | 监听蓝牙低功耗设备的特征值变化事件 |是|
| [wx.offBLEMTUChange](/miniprogram/dev/api/device/bluetooth-ble/wx.offBLEMTUChange.md)  | 移除蓝牙低功耗的最大传输单元变化事件的监听函数 |是|
| [wx.offBLEConnectionStateChange](/miniprogram/dev/api/device/bluetooth-ble/wx.offBLEConnectionStateChange.md)  | 移除蓝牙低功耗连接状态改变事件的监听函数 |是|
| [wx.offBLECharacteristicValueChange](/miniprogram/dev/api/device/bluetooth-ble/wx.offBLECharacteristicValueChange.md)  | 移除蓝牙低功耗设备的特征值变化事件的监听函数 |是|
| [wx.notifyBLECharacteristicValueChange](/miniprogram/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.md)  | 启用蓝牙低功耗设备特征值变化时的 notify 功能，订阅特征 |是|
| [wx.getBLEMTU](/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEMTU.md)  | 获取蓝牙低功耗的最大传输单元 |是|
| [wx.getBLEDeviceServices](/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEDeviceServices.md)  | 获取蓝牙低功耗设备所有服务 (service) |是|
| [wx.getBLEDeviceRSSI](/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEDeviceRSSI.md)  | 获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI) |是|
| [wx.getBLEDeviceCharacteristics](/miniprogram/dev/api/device/bluetooth-ble/wx.getBLEDeviceCharacteristics.md)  | 获取蓝牙低功耗设备某个服务中所有特征 (characteristic) |是|
| [wx.createBLEConnection](/miniprogram/dev/api/device/bluetooth-ble/wx.createBLEConnection.md)  | 连接蓝牙低功耗设备 |是|
| [wx.closeBLEConnection](/miniprogram/dev/api/device/bluetooth-ble/wx.closeBLEConnection.md)  | 断开与蓝牙低功耗设备的连接 |是|

### 蓝牙-低功耗外围设备
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.onBLEPeripheralConnectionStateChanged](/miniprogram/dev/api/device/bluetooth-peripheral/wx.onBLEPeripheralConnectionStateChanged.md)  | 监听当前外围设备被连接或断开连接事件 |是|
| [wx.offBLEPeripheralConnectionStateChanged](/miniprogram/dev/api/device/bluetooth-peripheral/wx.offBLEPeripheralConnectionStateChanged.md) | 移除当前外围设备被连接或断开连接事件的监听函数 |是|
| [wx.createBLEPeripheralServer](/miniprogram/dev/api/device/bluetooth-peripheral/wx.createBLEPeripheralServer.md)  | 建立本地作为[蓝牙低功耗外围设备的服务端](/miniprogram/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.md)，可创建多个 |是|

### 蓝牙-信标(Beacon)
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopBeaconDiscovery](/miniprogram/dev/api/device/ibeacon/wx.stopBeaconDiscovery.md)  | 停止搜索附近的 Beacon 设备 |是|
| [wx.startBeaconDiscovery](/miniprogram/dev/api/device/ibeacon/wx.startBeaconDiscovery.md)  | 开始搜索附近的 Beacon 设备 |是|
| [wx.onBeaconUpdate](/miniprogram/dev/api/device/ibeacon/wx.onBeaconUpdate.md)  | 监听 Beacon 设备更新事件，仅能注册一个监听 |是|
| [wx.onBeaconServiceChange](/miniprogram/dev/api/device/ibeacon/wx.onBeaconServiceChange.md)  | 监听 Beacon 服务状态变化事件，仅能注册一个监听 |是|
| [wx.offBeaconUpdate](/miniprogram/dev/api/device/ibeacon/wx.offBeaconUpdate.md)  | 移除 Beacon 设备更新事件的监听函数 |是|
| [wx.offBeaconServiceChange](/miniprogram/dev/api/device/ibeacon/wx.offBeaconServiceChange.md)  | 移除 Beacon 服务状态变化事件的监听函数 |是|
| [wx.getBeacons](/miniprogram/dev/api/device/ibeacon/wx.getBeacons.md)  | 获取所有已搜索到的 Beacon 设备 |是|
| [BeaconInfo](/miniprogram/dev/api/device/ibeacon/BeaconInfo.md)  | Beacon 设备 |是|

### 近场通讯（NFC）

- NFC JSAPI 依赖扩展 SDK 「NFC SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选方可生效
- Android SDK >= 1.5.6

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getNFCAdapter](/miniprogram/dev/api/device/nfc/wx.getNFCAdapter.md)  | 获取 NFC 实例 |是|

### Wi-Fi

- 下方 WIFI 相关的 JSAPI 依赖扩展 SDK 「Network SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选对应的 SDK 方可生效；
- 注意：Android 和 iOS 的扩展 SDK 有所区别，详情查看 `project.miniapp.json` 
- 注意：iOS 13 及以上系统，获取当前连接的 Wi-Fi 信息需要先获取系统定位权限，因此在 iOS 13 及以上系统使用此接口时，需要先调用`wx.getLocation`，触发定位权限申请的弹窗，待用户授权后才可以正常获取到 wifi 信息

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopWifi](/miniprogram/dev/api/device/wifi/wx.stopWifi.md)  | 关闭 Wi-Fi 模块 |是|
| [wx.startWifi](/miniprogram/dev/api/device/wifi/wx.startWifi.md)  | 初始化 Wi-Fi 模块 |是|
| [wx.setWifiList](/miniprogram/dev/api/device/wifi/wx.setWifiList.md)  | 设置 `wifiList` 中 AP 的相关信息 |是|
| [wx.onWifiConnected](/miniprogram/dev/api/device/wifi/wx.onWifiConnected.md)  | 监听连接上 Wi-Fi 的事件 |是|
| [wx.offWifiConnected](/miniprogram/dev/api/device/wifi/wx.offWifiConnected.md)  | 移除连接上 Wi-Fi 的事件的监听函数 |是|
| [wx.onGetWifiList](/miniprogram/dev/api/device/wifi/wx.onGetWifiList.md)  | 监听获取到 Wi-Fi 列表数据事件 |是|
| [wx.offGetWifiList](/miniprogram/dev/api/device/wifi/wx.offGetWifiList.md)  | 移除获取到 Wi-Fi 列表数据事件的监听函数 |是|
| [wx.onWifiConnectedWithPartialInfo](/miniprogram/dev/api/device/wifi/wx.onWifiConnectedWithPartialInfo.md)  | 监听连接上 Wi-Fi 的事件 |否[2]|
| [wx.offWifiConnectedWithPartialInfo](/miniprogram/dev/api/device/wifi/wx.offWifiConnectedWithPartialInfo.md)  | 移除连接上 Wi-Fi 的事件的监听函数 |否[2]|
| [wx.getWifiList](/miniprogram/dev/api/device/wifi/wx.getWifiList.md)  | 请求获取 Wi-Fi 列表 |是|
| [wx.getConnectedWifi](/miniprogram/dev/api/device/wifi/wx.getConnectedWifi.md)  | 获取已连接中的 Wi-Fi 信息 |是|
| [wx.connectWifi](/miniprogram/dev/api/device/wifi/wx.connectWifi.md)  | 连接 Wi-Fi |是|
| [WifiInfo](/miniprogram/dev/api/device/wifi/WifiInfo.md)  | Wifi 信息 |是|

### 日历
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.addPhoneRepeatCalendar](/miniprogram/dev/api/device/calendar/wx.addPhoneRepeatCalendar.md)  | 向系统日历添加重复事件 |是|
| [wx.addPhoneCalendar](/miniprogram/dev/api/device/calendar/wx.addPhoneCalendar.md)  | 向系统日历添加事件 |是|

### 联系人
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.chooseContact](/miniprogram/dev/api/device/contact/wx.chooseContact.md)  | 拉起手机通讯录，选择联系人 |是|
| [wx.addPhoneContact](/miniprogram/dev/api/device/contact/wx.addPhoneContact.md)  | 添加手机通讯录联系人 |是|

### 无障碍
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.checkIsOpenAccessibility](/miniprogram/dev/api/device/accessibility/wx.checkIsOpenAccessibility.md)  | 检测是否开启视觉无障碍功能 |否[4]|

### 电量
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getBatteryInfoSync](/miniprogram/dev/api/device/battery/wx.getBatteryInfoSync.md)  | wx.getBatteryInfo 的同步版本 |是|
| [wx.getBatteryInfo](/miniprogram/dev/api/device/battery/wx.getBatteryInfo.md)  | 获取设备电量 |是|

### 剪贴板
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.setClipboardData](/miniprogram/dev/api/device/clipboard/wx.setClipboardData.md)  | 设置系统剪贴板的内容 |是|
| [wx.getClipboardData](/miniprogram/dev/api/device/clipboard/wx.getClipboardData.md)  | 获取系统剪贴板的内容 |是|

### NFC 主机卡模拟

- NFC JSAPI 依赖扩展 SDK 「NFC SDK」 ,开发者需在项目中的 `project.miniapp.json` 配置勾选方可生效
- Android SDK >= 1.5.6

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopHCE](/miniprogram/dev/api/device/nfc-hce/wx.stopHCE.md)  | 关闭 NFC 模块 |是|
| [wx.startHCE](/miniprogram/dev/api/device/nfc-hce/wx.startHCE.md)  | 初始化 NFC 模块 |是|
| [wx.sendHCEMessage](/miniprogram/dev/api/device/nfc-hce/wx.sendHCEMessage.md)  | 发送 NFC 消息 |是|
| [wx.onHCEMessage](/miniprogram/dev/api/device/nfc-hce/wx.onHCEMessage.md)  | 监听接收 NFC 设备消息事件 |是|
| [wx.offHCEMessage](/miniprogram/dev/api/device/nfc-hce/wx.offHCEMessage.md)  | 移除接收 NFC 设备消息事件的监听函数 |是|
| [wx.getHCEState](/miniprogram/dev/api/device/nfc-hce/wx.getHCEState.md)  | 判断当前设备是否支持 HCE 能力 |是|

### 网络
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.onNetworkWeakChange](/miniprogram/dev/api/device/network/wx.onNetworkWeakChange.md)  | 监听弱网状态变化事件 |是|
| [wx.onNetworkStatusChange](/miniprogram/dev/api/device/network/wx.onNetworkStatusChange.md)  | 监听网络状态变化事件 |是|
| [wx.offNetworkWeakChange](/miniprogram/dev/api/device/network/wx.offNetworkWeakChange.md)  | 移除弱网状态变化事件的监听函数 |是|
| [wx.offNetworkStatusChange](/miniprogram/dev/api/device/network/wx.offNetworkStatusChange.md)  | 移除网络状态变化事件的监听函数 |是|
| [wx.getNetworkType](/miniprogram/dev/api/device/network/wx.getNetworkType.md)  | 获取网络类型 |是|
| [wx.getLocalIPAddress](/miniprogram/dev/api/device/network/wx.getLocalIPAddress.md)  | 获取局域网 IP 地址 |否[2]|

### 加密
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getRandomValues](/miniprogram/dev/api/device/crypto/wx.getRandomValues.md)  | 获取密码学安全随机数 |是|

### 屏幕
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.setVisualEffectOnCapture](/miniprogram/dev/api/device/screen/wx.setVisualEffectOnCapture.md)  | 设置截屏/录屏时屏幕表现，仅支持在 Android 端调用 |否[2]|
| [wx.setScreenBrightness](/miniprogram/dev/api/device/screen/wx.setScreenBrightness.md)  | 设置屏幕亮度 |是|
| [wx.setKeepScreenOn](/miniprogram/dev/api/device/screen/wx.setKeepScreenOn.md)  | 设置是否保持常亮状态 |是|
| [wx.onUserCaptureScreen](/miniprogram/dev/api/device/screen/wx.onUserCaptureScreen.md)  | 监听用户主动截屏事件 |是|
| [wx.onScreenRecordingStateChanged](/miniprogram/dev/api/device/screen/wx.onScreenRecordingStateChanged.md)  | 监听用户录屏事件 |是|
| [wx.offUserCaptureScreen](/miniprogram/dev/api/device/screen/wx.offUserCaptureScreen.md)  | 用户主动截屏事件 |是|
| [wx.offScreenRecordingStateChanged](/miniprogram/dev/api/device/screen/wx.offScreenRecordingStateChanged.md)  | 移除用户录屏事件的监听函数 |是|
| [wx.getScreenRecordingState](/miniprogram/dev/api/device/screen/wx.getScreenRecordingState.md)  | 查询用户是否在录屏 |是|
| [wx.getScreenBrightness](/miniprogram/dev/api/device/screen/wx.getScreenBrightness.md)  | 获取屏幕亮度 |是|

### 键盘
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.onKeyboardHeightChange](/miniprogram/dev/api/device/keyboard/wx.onKeyboardHeightChange.md)  | 监听键盘高度变化事件 |是|
| [wx.offKeyboardHeightChange](/miniprogram/dev/api/device/keyboard/wx.offKeyboardHeightChange.md)  | 移除键盘高度变化事件的监听函数 |是|
| [wx.hideKeyboard](/miniprogram/dev/api/device/keyboard/wx.hideKeyboard.md)  | 在 input、textarea 等 focus 拉起键盘之后，手动调用此接口收起键盘 |是|
| [wx.getSelectedTextRange](/miniprogram/dev/api/device/keyboard/wx.getSelectedTextRange.md)  | 在 input、textarea 等 focus 之后，获取输入框的光标位置 |是|

### 电话

注：此接口在 iOS 多端应用中使用需前往 `project.miniapp.json` 勾选「Others SDK」

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.makePhoneCall](/miniprogram/dev/api/device/phone/wx.makePhoneCall.md)  | 拨打电话 |是|

### 加速计
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopAccelerometer](/miniprogram/dev/api/device/accelerometer/wx.stopAccelerometer.md)  | 停止监听加速度数据 |是|
| [wx.startAccelerometer](/miniprogram/dev/api/device/accelerometer/wx.startAccelerometer.md)  | 开始监听加速度数据 |是|
| [wx.onAccelerometerChange](/miniprogram/dev/api/device/accelerometer/wx.onAccelerometerChange.md)  | 监听加速度数据事件 |是|
| [wx.offAccelerometerChange](/miniprogram/dev/api/device/accelerometer/wx.offAccelerometerChange.md)  | 移除加速度数据事件的监听函数 |是|

### 罗盘
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopCompass](/miniprogram/dev/api/device/compass/wx.stopCompass.md)  | 停止监听罗盘数据 |是|
| [wx.startCompass](/miniprogram/dev/api/device/compass/wx.startCompass.md)  | 开始监听罗盘数据 |是|
| [wx.onCompassChange](/miniprogram/dev/api/device/compass/wx.onCompassChange.md)  | 监听罗盘数据变化事件 |是|
| [wx.offCompassChange](/miniprogram/dev/api/device/compass/wx.offCompassChange.md)  | 移除罗盘数据变化事件的监听函数 |是|

### 设备方向
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopDeviceMotionListening](/miniprogram/dev/api/device/motion/wx.stopDeviceMotionListening.md)  | 停止监听设备方向的变化 |是|
| [wx.startDeviceMotionListening](/miniprogram/dev/api/device/motion/wx.startDeviceMotionListening.md)  | 开始监听设备方向的变化 |是|
| [wx.onDeviceMotionChange](/miniprogram/dev/api/device/motion/wx.onDeviceMotionChange.md)  | 监听设备方向变化事件 |是|
| [wx.offDeviceMotionChange](/miniprogram/dev/api/device/motion/wx.offDeviceMotionChange.md)  | 移除设备方向变化事件的监听函数 |是|

### 内存
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.onMemoryWarning](/miniprogram/dev/api/device/memory/wx.onMemoryWarning.md)  | 监听内存不足告警事件 |是|
| [wx.offMemoryWarning](/miniprogram/dev/api/device/memory/wx.offMemoryWarning.md)  | 移除内存不足告警事件的监听函数 |是|

### 陀螺仪
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopGyroscope](/miniprogram/dev/api/device/gyroscope/wx.stopGyroscope.md)  | 停止监听陀螺仪数据 |是|
| [wx.startGyroscope](/miniprogram/dev/api/device/gyroscope/wx.startGyroscope.md)  | 开始监听陀螺仪数据 |是|
| [wx.onGyroscopeChange](/miniprogram/dev/api/device/gyroscope/wx.onGyroscopeChange.md)  | 监听陀螺仪数据变化事件 |是|

### 扫码

注：

- 此接口在 iOS 多端应用中使用需前往 `project.miniapp.json` 勾选「Others SDK」，并且需要在 `project.miniapp.json` 中配置 `NSCameraUsageDescription`
- 在 Android 端则需要前往 project.miniapp.json 勾选「 Scanner SDK」

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.scanCode](/miniprogram/dev/api/device/scan/wx.scanCode.md)  | 调起客户端扫码界面进行扫码 |是|

### 短信

- 此接口在 iOS 多端应用中使用需前往 `project.miniapp.json` 勾选「Others SDK」

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.sendSms](/miniprogram/dev/api/device/sms/wx.sendSms.md)  | 拉起手机发送短信界面 |支持|

### 振动

注：此接口在 iOS 多端应用中使用需前往 `project.miniapp.json` 勾选「Others SDK」

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.vibrateShort](/miniprogram/dev/api/device/vibrate/wx.vibrateShort.md)  | 使手机发生较短时间的振动（15 ms） |是|
| [wx.vibrateLong](/miniprogram/dev/api/device/vibrate/wx.vibrateLong.md)  | 使手机发生较长时间的振动（400 ms) |是|

## AI

### 视觉算法
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.isVKSupport](/miniprogram/dev/api/ai/visionkit/wx.isVKSupport.md)  | 判断支持版本 |否[4]|
| [wx.createVKSession](/miniprogram/dev/api/ai/visionkit/wx.createVKSession.md)  | 创建 vision kit 会话对象 |否[4]|

### 人脸检测
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.stopFaceDetect](/miniprogram/dev/api/ai/face/wx.stopFaceDetect.md)  | 停止人脸检测 |否[4]|
| [wx.initFaceDetect](/miniprogram/dev/api/ai/face/wx.initFaceDetect.md)  | 初始化人脸检测 |否[4]|
| [wx.faceDetect](/miniprogram/dev/api/ai/face/wx.faceDetect.md)  | 人脸检测，使用前需要通过 wx.initFaceDetect 进行一次初始化，推荐使用相机接口返回的帧数据 |否[4]|

## Worker
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createWorker](/miniprogram/dev/api/worker/wx.createWorker.md)  | 创建一个 [Worker 线程](/miniprogram/dev/api/worker/Worker.md) |是|

## WXML

wx.createSelectorQuery 在 Android 端需使用需前往 `project.miniapp.json` 勾选「XWEB SDK」

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createSelectorQuery](/miniprogram/dev/api/wxml/wx.createSelectorQuery.md)  | 返回一个 [SelectorQuery](/miniprogram/dev/api/wxml/SelectorQuery.md) 对象实例 |是|
| [wx.createIntersectionObserver](/miniprogram/dev/api/wxml/wx.createIntersectionObserver.md)  | 创建并返回一个 [IntersectionObserver](/miniprogram/dev/api/wxml/IntersectionObserver.md) 对象实例 |是|

## 第三方平台
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getExtConfigSync](/miniprogram/dev/api/ext/wx.getExtConfigSync.md)  | wx.getExtConfig 的同步版本 |否[2]|
| [wx.getExtConfig](/miniprogram/dev/api/ext/wx.getExtConfig.md)  | 获取 ext.json 自定义的数据字段 |否[2]|

## 广告
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.createRewardedVideoAd](/miniprogram/dev/platform-capabilities/miniapp/handbook/devtools/ad)  | 创建[激励视频广告组件](/miniprogram/dev/api/ad/RewardedVideoAd.md) |是，详情可查看[腾讯优量汇广告使用指南](/miniprogram/dev/platform-capabilities/miniapp/handbook/devtools/ad)|
| [wx.createInterstitialAd](/miniprogram/dev/api/ad/wx.createInterstitialAd.md)  | 创建[插屏广告组件](/miniprogram/dev/api/ad/InterstitialAd.md) |否[2]|

## 开放接口

### 登录

| 名称 | 功能说明 |是否支持 | 备注 |
| -- | -- |-- | --- |
| [wx.pluginLogin](/miniprogram/dev/api/open-api/login/wx.pluginLogin.md)  | __该接口仅在小程序插件中可调用__，调用接口获得插件用户标志凭证（code） |否[2]|  |
| wx.login  | 调用接口获取登录凭证（code） |  是[2] | 需替换新接口，[点击查看接口详情](diffapi/wx.login)|
| [wx.checkSession](/miniprogram/dev/api/open-api/login/wx.checkSession.md)  | 检查登录态是否过期 |否[1]|  使用多端身份管理 |

### 账号信息

- 与小程序模式下返回的信息有差异，详情看接口文档

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getAccountInfoSync](diffapi/getAccountInfo)  | 获取当前账号信息 | 是 |

### 用户信息

- 在 App 中开发者可以通过对接「微信登录」的接口获取用户微信的头像和昵称，详情可查看[wx.miniapp.login](miniapp/login)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getUserProfile](/miniprogram/dev/api/open-api/user-info/wx.getUserProfile.md)  | 获取用户信息 |否[2]|
| [wx.getUserInfo](/miniprogram/dev/api/open-api/user-info/wx.getUserInfo.md)  | 获取[用户信息](/miniprogram/dev/api/open-api/user-info/UserInfo.md) |否[2]|

### 授权

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.authorizeForMiniProgram](/miniprogram/dev/api/open-api/authorize/wx.authorizeForMiniProgram.md)  | **仅小程序插件中能调用该接口**，用法同 wx.authorize  | 否[4] |
| [wx.authorize](/miniprogram/dev/api/open-api/authorize/wx.authorize.md)  | 提前向用户发起授权请求 | 否[4] |

### 设置

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.openSetting](/miniprogram/dev/api/open-api/setting/wx.openSetting.md)  | 调起客户端小程序设置界面，返回用户设置的操作结果 |否[4] |
| [wx.getSetting](/miniprogram/dev/api/open-api/setting/wx.getSetting.md)  | 获取用户的当前设置 |否[4] |
| [AuthSetting](/miniprogram/dev/api/open-api/setting/AuthSetting.md)  | 用户授权设置信息，详情参考[权限](/miniprogram/dev/framework/open-ability/authorize.md) |否[4] |
| [SubscriptionsSetting](/miniprogram/dev/api/open-api/setting/SubscriptionsSetting.md)  | 订阅消息设置 |否[4] |

### 收货地址
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.chooseAddress](/miniprogram/dev/api/open-api/address/wx.chooseAddress.md)  | 获取用户收货地址 |否[4] |

### 卡券
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.openCard](/miniprogram/dev/api/open-api/card/wx.openCard.md)  | 查看微信卡包中的卡券 |否[4] |
| [wx.addCard](/miniprogram/dev/api/open-api/card/wx.addCard.md)  | 批量添加卡券 |否[4] |

### 发票
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.chooseInvoiceTitle](/miniprogram/dev/api/open-api/invoice/wx.chooseInvoiceTitle.md)  | 选择用户的发票抬头 |否[4] |
| [wx.chooseInvoice](/miniprogram/dev/api/open-api/invoice/wx.chooseInvoice.md)  | 选择用户已有的发票 |否[4] |

### 生物认证
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.startSoterAuthentication](/miniprogram/dev/api/open-api/soter/wx.startSoterAuthentication.md)  | 开始 SOTER 生物认证 |否[4] |
| [wx.checkIsSupportSoterAuthentication](/miniprogram/dev/api/open-api/soter/wx.checkIsSupportSoterAuthentication.md)  | 获取本机支持的 SOTER 生物认证方式 |否[4] |
| [wx.checkIsSoterEnrolledInDevice](/miniprogram/dev/api/open-api/soter/wx.checkIsSoterEnrolledInDevice.md)  | 获取设备内是否录入如指纹等生物信息的接口 |否[4] |

### 微信运动
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.shareToWeRun](/miniprogram/dev/api/open-api/werun/wx.shareToWeRun.md)  | 分享数据到微信运动 |否[4] |
| [wx.getWeRunData](/miniprogram/dev/api/open-api/werun/wx.getWeRunData.md)  | 获取用户过去三十天微信运动步数 |否[4] |

### 订阅消息

- 小程序订阅消息能力在 App 中无法使用；
- App 中支持[一次性订阅消息](miniapp/requestSubscribeMessage)
- App 的消息推送可查看[消息推送使用指南](/miniprogram/dev/platform-capabilities/miniapp/handbook/devtools/impush)

| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.requestSubscribeMessage](/miniprogram/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.md)  | 调起客户端小程序订阅消息界面，返回用户订阅消息的操作结果 |否[4] |
| [wx.requestSubscribeDeviceMessage](/miniprogram/dev/api/open-api/subscribe-message/wx.requestSubscribeDeviceMessage.md)  | 订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息 |否[4] |

### 微信红包
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.showRedPackage](/miniprogram/dev/api/open-api/redpackage/wx.showRedPackage.md)  | 拉取h5领取红包封面页 |否[4] |

### 收藏
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.addVideoToFavorites](/miniprogram/dev/api/open-api/favorites/wx.addVideoToFavorites.md)  | 收藏视频 |否[4] |
| [wx.addFileToFavorites](/miniprogram/dev/api/open-api/favorites/wx.addFileToFavorites.md)  | 收藏文件 |否[4] |

### 车牌
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.chooseLicensePlate](/miniprogram/dev/api/open-api/license-plate/wx.chooseLicensePlate.md)  | 选择车牌号 |否[4] |

### 视频号
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.reserveChannelsLive](/miniprogram/dev/api/open-api/channels/wx.reserveChannelsLive.md)  | 预约视频号直播 |否[4] |
| [wx.openChannelsUserProfile](/miniprogram/dev/api/open-api/channels/wx.openChannelsUserProfile.md)  | 打开视频号主页 |否[4] |
| [wx.openChannelsLive](/miniprogram/dev/api/open-api/channels/wx.openChannelsLive.md)  | 打开视频号直播 |否[4] |
| [wx.openChannelsEvent](/miniprogram/dev/api/open-api/channels/wx.openChannelsEvent.md)  | 打开视频号活动页 |否[4] |
| [wx.openChannelsActivity](/miniprogram/dev/api/open-api/channels/wx.openChannelsActivity.md)  | 打开视频号视频 |否[4] |
| [wx.getChannelsShareKey](/miniprogram/dev/api/open-api/channels/wx.getChannelsShareKey.md)  | 获取视频号直播卡片/视频卡片的分享来源，仅当卡片携带了分享信息、同时用户已授权该小程序获取视频号分享信息且启动场景值为 1177、1184、1195、1208 时可用 |否[4] |
| [wx.getChannelsLiveNoticeInfo](/miniprogram/dev/api/open-api/channels/wx.getChannelsLiveNoticeInfo.md)  | 获取视频号直播预告信息 |否[4] |
| [wx.getChannelsLiveInfo](/miniprogram/dev/api/open-api/channels/wx.getChannelsLiveInfo.md)  | 获取视频号直播信息 |否[4] |

### 微信群
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.getGroupEnterInfo](/miniprogram/dev/api/open-api/group/wx.getGroupEnterInfo.md)  | 获取微信群聊场景下的小程序启动信息 |不支持|
### 微信客服
| 名称 | 功能说明 |是否支持 |
| -- | -- |-- |
| [wx.openCustomerServiceChat](/miniprogram/dev/api/open-api/service-chat/wx.openCustomerServiceChat.md)  | 打开微信客服，页面产生点击事件（例如 button 上 bindtap 的回调中）后才可调用 |不支持；可使用 [wx.miniapp.openCustomerServiceChat](miniapp/openCustomerServiceChat) 替代|

## 多端框架新增 API

- 即，除了小程序已有的 JSAPI ，多端框架也为 App 的功能开放了更多仅适用于多端应用的 API，包括多端框架的通用 API 和身份管理 API
- API 列表的查看路径如下：

![](https://testchu-7gy8occc8dcc14c3-1304825656.tcloudbaseapp.com/img%2Fmelody%2F202503121732616.png)