API 全量清单

本页按微信开放文档的能力域来组织 @wevu/api 当前收录的完整 API 目录。

能力域入口：

• 基础
• 路由
• 跳转
• 聊天工具
• 转发
• 界面
• 网络
• 支付
• 数据缓存
• 数据分析
• 画布
• 媒体
• 位置
• 文件
• 开放接口
• 设备
• AI
• Worker
• WXML
• 第三方平台
• 广告
• XR-FRAME

每个能力域下都保留：

• API 是什么
• 一段最小用法示例
• 微信开放文档搜索入口
• 微信 / 支付宝 / 抖音三端的当前策略

基础路由跳转聊天工具转发界面网络支付数据缓存数据分析画布媒体位置文件开放接口设备AIWorkerWXML第三方平台广告XR-FRAME

共 49 / 49 个当前能力域 API

基础

getSystemInfoAsync

⚠️

异步获取系统信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getSystemInfoAsync`
• 支付宝：映射到 `my.getSystemInfo`
• 抖音：映射到 `tt.getSystemInfo`

openAppAuthorizeSetting

⚠️

打开小程序授权设置页。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.openAppAuthorizeSetting`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getEnterOptionsSync

⚠️

获取启动参数（同步）。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getEnterOptionsSync`
• 支付宝：直连 `my.getEnterOptionsSync`
• 抖音：无同等 API，调用时按 unsupported 报错

getSystemSetting

⚠️

获取系统设置。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getSystemSetting`
• 支付宝：直连 `my.getSystemSetting`
• 抖音：无同等 API，调用时按 unsupported 报错

getAppAuthorizeSetting

⚠️

获取 App 授权设置。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getAppAuthorizeSetting`
• 支付宝：直连 `my.getAppAuthorizeSetting`
• 抖音：无同等 API，调用时按 unsupported 报错

getAppBaseInfo

⚠️

获取 App 基础信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getAppBaseInfo`
• 支付宝：直连 `my.getAppBaseInfo`
• 抖音：无同等 API，调用时按 unsupported 报错

getWindowInfo

⚠️

获取窗口信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getWindowInfo`
• 支付宝：直连 `my.getWindowInfo`
• 抖音：无同等 API，调用时按 unsupported 报错

getDeviceInfo

⚠️

获取设备基础信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getDeviceInfo`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getLogManager

⚠️

获取日志管理器实例。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getLogManager`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

joinVoIPChat

⚠️

加入音视频通话。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.joinVoIPChat`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

cancelIdleCallback

⚠️

取消空闲回调。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.cancelIdleCallback`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

addPaymentPassFinish

⚠️

添加支付 pass 完成回调。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.addPaymentPassFinish`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

addPaymentPassGetCertificateData

⚠️

添加支付 pass 证书数据回调。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.addPaymentPassGetCertificateData`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

canAddSecureElementPass

⚠️

检测是否可添加安全元素卡片。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.canAddSecureElementPass`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

checkDeviceSupportHevc

⚠️

检测设备是否支持 HEVC 解码。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.checkDeviceSupportHevc`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

checkIsSoterEnrolledInDevice

⚠️

检测设备是否录入 SOTER 信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.checkIsSoterEnrolledInDevice`
• 支付宝：映射到 `my.checkIsIfaaEnrolledInDevice`，`speech` 模式按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

checkIsSupportSoterAuthentication

⚠️

检测设备是否支持 SOTER 生物认证。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.checkIsSupportSoterAuthentication`
• 支付宝：映射到 `my.checkIsSupportIfaaAuthentication`
• 抖音：无同等 API，调用时按 unsupported 报错

reportPerformance

⚠️

上报性能数据。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.reportPerformance`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

postMessageToReferrerMiniProgram

⚠️

向来源小程序发送消息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.postMessageToReferrerMiniProgram`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

postMessageToReferrerPage

⚠️

向来源页面发送消息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.postMessageToReferrerPage`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

preDownloadSubpackage

⚠️

预下载分包。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.preDownloadSubpackage`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

preloadAssets

⚠️

预加载资源。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.preloadAssets`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

preloadSkylineView

⚠️

预加载 Skyline 视图。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.preloadSkylineView`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

preloadWebview

⚠️

预加载 WebView 页面。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.preloadWebview`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

removeSecureElementPass

⚠️

移除安全元素卡片。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.removeSecureElementPass`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

exitVoIPChat

⚠️

退出音视频通话。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.exitVoIPChat`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getApiCategory

⚠️

获取 API 分类信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getApiCategory`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getBackgroundFetchToken

⚠️

获取后台拉取 token。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getBackgroundFetchToken`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

join1v1Chat

⚠️

发起 1v1 通话。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.join1v1Chat`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

shareToWeRun

⚠️

分享至微信运动。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.shareToWeRun`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

showRedPackage

⚠️

展示红包组件。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.showRedPackage`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

startRecord

⚠️

开始录音。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.startRecord`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

startSoterAuthentication

⚠️

开始 SOTER 认证。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.startSoterAuthentication`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

setBackgroundFetchToken

⚠️

设置后台拉取 token。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.setBackgroundFetchToken`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

setEnable1v1Chat

⚠️

设置 1v1 通话可用状态。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.setEnable1v1Chat`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

stopRecord

⚠️

停止录音。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.stopRecord`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

updateVoIPChatMuteConfig

⚠️

更新 VoIP 静音配置。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.updateVoIPChatMuteConfig`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

updateWeChatApp

⚠️

拉起微信升级流程。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.updateWeChatApp`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getDeviceBenchmarkInfo

⚠️

获取设备性能评估信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getDeviceBenchmarkInfo`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getPerformance

⚠️

获取性能对象。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getPerformance`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getRealtimeLogManager

⚠️

获取实时日志管理器。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getRealtimeLogManager`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getRendererUserAgent

⚠️

获取渲染层 UserAgent。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getRendererUserAgent`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getSecureElementPasses

⚠️

获取安全元素卡片列表。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getSecureElementPasses`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getSelectedTextRange

⚠️

获取已选中文本范围。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getSelectedTextRange`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getSkylineInfo

⚠️

获取 Skyline 信息。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getSkylineInfo`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getUserCryptoManager

⚠️

获取用户加密管理器。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getUserCryptoManager`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

getWeRunData

⚠️

获取微信运动数据。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.getWeRunData`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

requestIdleCallback

⚠️

空闲时回调请求。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.requestIdleCallback`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错

setEnableDebug

⚠️

设置调试开关。

微信开放文档搜索

大概用法

三端策略

• 微信：直连 `wx.setEnableDebug`
• 支付宝：无同等 API，调用时按 unsupported 报错
• 抖音：无同等 API，调用时按 unsupported 报错