#JS API 概览
#存储
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| clearStorage | 清空本地缓存。 | 支持 | 支持 |
| clearStorageSync | 清空本地缓存。 | 支持 | 支持 |
| getStorage | 从本地缓存读取数据。 | 支持 | 支持 |
| getStorageInfo | 获取本地缓存信息。 | 支持 | 支持 |
| getStorageInfoSync | 同步获取本地缓存信息。 | 支持 | 支持 |
| getStorageSync | 从本地缓存同步读取数据。 | 支持 | 支持 |
| removeStorage | 删除本地缓存中指定 key 的数据。 | 支持 | 支持 |
| removeStorageSync | 删除本地缓存中指定 key 的数据。 | 支持 | 支持 |
| setStorage | 将数据写入本地缓存。 | 支持 | 支持 |
| setStorageSync | 将数据写入本地缓存。 | 支持 | 支持 |
#定位
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getLocation | 获取设备当前的地理位置信息。 | 支持 | 支持 |
| onLocationChange | 注册地理位置变化回调。 | 支持 | 不支持 |
| onLocationChangeError | 注册位置更新异常回调。 | 支持 | 不支持 |
| startLocationUpdate | 开始接收位置更新。 | 支持 | 不支持 |
| stopLocationUpdate | 停止接收位置更新。 | 支持 | 不支持 |
#基础
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| arrayBufferToBase64 | 将 ArrayBuffer 转换为 Base64 字符串。 | 支持 | 支持 |
| authorize | 提前向用户发起指定 scope 的授权;scope.healthData 仅用于选择 iOS HealthKit 系统授权路径。 | 支持 | 不支持 |
| base64ToArrayBuffer | 将 Base64 字符串转换为 ArrayBuffer。 | 支持 | 支持 |
| canIUse | 检测当前环境是否支持指定 API 或能力。 | - | - |
| getAccountInfo | 异步获取账号信息。 | 支持 | 支持 |
| getAccountInfoSync | 同步获取账号信息。 | 支持 | 支持 |
| getPerformance | 获取当前应用插件的性能数据。
Entry 由客户端保存; | 支持 | 支持 |
| getSetting | 获取用户当前的应用授权设置。 | 支持 | 支持 |
| openSetting | 打开应用插件授权设置页面 | 支持 | 支持 |
#基础/系统
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getAppAuthorizeSetting | 获取豆包客户端的系统授权设置。
调用只读取当前系统授权状态,不会申请权限或触发系统授权弹窗。原有状态字段固定返回
| 支持 | 支持 |
| getAppBaseInfo | 获取应用基础信息。 | 支持 | 支持 |
| getAppBaseInfoSync | 获取应用基础信息。 | 支持 | 支持 |
| getSystemInfo | 获取系统信息。 | 支持 | 支持 |
| getSystemInfoSync | 同步获取系统信息。 | 支持 | 支持 |
| getSystemSetting | 获取设备设置。 | 支持 | 支持 |
| getWindowInfo | 获取窗口信息。 | 支持 | 不支持 |
| getWindowInfoSync | 获取窗口信息。 | 支持 | 不支持 |
| onThemeChange | 监听应用主题变化。
当用户在系统设置或豆包客户端内切换浅色、深色主题时触发。回调参数中的 | 支持 | 支持 |
#界面
| API | 说明 | 页面 | 卡片 |
|---|
#界面/交互
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| disableAlertBeforeUnload | 关闭页面返回前提醒。 | - | - |
| enableAlertBeforeUnload | 开启页面返回前提醒。
当用户在应用插件的非最底层页面点击左上角返回按钮、左上角首页按钮或客户端返回键时,弹起询问弹窗
返回询问对话框只会对调用的当前页面生效,通过手势滑动返回时不会弹起询问对话框 | - | - |
| getMenuButtonBoundingClientRect | 取菜单按钮(右上角胶囊按钮)的布局位置信息。 | 支持 | 不支持 |
| hideLoading | 隐藏当前 loading。 | 支持 | 不支持 |
| hideToast | 隐藏当前 Toast。 | 支持 | 支持 |
| showActionSheet | 显示操作菜单。 | 支持 | 支持 |
| showBottomSheet | 显示豆包底部弹窗。 | 支持 | 支持 |
| showLoading | 显示 loading 提示框。 | 支持 | 不支持 |
| showModal | 显示模态对话框。 | 支持 | 支持 |
| showToast | 显示 Toast 提示。 | 支持 | 支持 |
#界面/输入
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| hideKeyboard | 收起当前键盘。 | 支持 | 不支持 |
| onKeyboardHeightChange | 监听键盘高度变化事件。 | 支持 | 不支持 |
#开放能力/登录
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| login | 获取当前豆包用户的一次性登录凭证。 | 支持 | 支持 |
| loginWithDoubaoWidget | 在 Widget 中拉起平台登录和隐私协议授权交互。 | 支持 | 支持 |
| postLoginResult | 向豆包回传三方 MCP 授权登录结果。 | 支持 | 支持 |
#开放能力/业务能力
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| callTool | 调用当前应用的 Tool。
豆包会根据当前应用插件页面或会话 Widget 确定应用和版本,开发者只需传入 Tool 名称和参数。
Tool 正常结果通过 | 支持 | 支持 |
| createTask | 创建任务。 | 支持 | 支持 |
| expiredWidget | 更新过期的 Widget 为固定卡片。 | 支持 | 支持 |
| getPrivacySetting | 获取隐私设置状态。 | 支持 | 支持 |
| sendFollowUpMessage | 以用户身份发送后续消息,触发新一轮对话、API 调用或引导模型响应。 | 支持 | 支持 |
| updateModelContext | 向 Agent 捐赠上下文。 | 支持 | 支持 |
| updateWidget | 更新指定 Widget 卡片实例的渲染数据。
用于卡片内操作后刷新卡片展示、把服务端最新结果写回卡片,或由 Page 根据传入的
| 支持 | 支持 |
#开放能力/支付
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| createSignOrder | 创建三方纯签约流程所需的签约单。 | 支持 | 支持 |
| dypay | 发起抖音支付流程。 | - | - |
| getOrderPayment | 使用预下单返回的平台交易订单号拉起用户收银台。 | 支持 | 支持 |
| getOrderPaymentWithSign | 使用预下单号和签约参数拉起支付并签约收银台。 | 支持 | 支持 |
| requestOrder | 交易预下单,获取拉起收银台所需的平台交易订单号。 | 支持 | 支持 |
| sign | 使用三方纯签约的签约单号拉起用户签约页面。 | 支持 | 支持 |
#路由
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| exitApp | 退出当前所有页面。 | 支持 | 不支持 |
| navigateBack | 关闭当前页面,返回上一页面或多级页面。 | 支持 | 不支持 |
| navigateTo | 保留当前页面,跳转到应用内的某个页面。 | 支持 | 支持 |
| navigateToDouyinMiniProgram | 在豆包内打开指定版本的抖音应用插件。 | 支持 | 支持 |
| openPage | 打开应用内页面。
在主对话流卡片中调用时会重新打开全页并忽略 | - | - |
| openPageInChat | 在当前关联的主对话流中以半屏形式打开应用内页面。
调用后不会创建或操作全页页面栈。需要进入全页应用插件或操作已有页面栈时,请使用 openPage。 | 支持 | 支持 |
| redirectTo | 关闭当前页面,跳转到应用内的某个页面。 | 支持 | 不支持 |
| reLaunch | 关闭所有页面并跳转到应用内页面。 | 支持 | 不支持 |
#媒体
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| chooseImage | 选择图片。 | 支持 | 不支持 |
| compressImage | 压缩图片。 | 支持 | 不支持 |
| createInnerAudioContext | 创建一个内部音频上下文。 | 支持 | 不支持 |
| getBackgroundAudioManager | 获取全局唯一的背景音频管理器。 | 支持 | 不支持 |
| getImageInfo | 获取图片信息。 | 支持 | 不支持 |
| getRecorderManager | 获取全局唯一的录音管理器。 | 支持 | 不支持 |
| previewImage | 预览图片。 | 支持 | 支持 |
| saveImageToPhotosAlbum | 保存图片到系统相册。
需要先确保应用已具备写入系统相册的权限。 | 支持 | 不支持 |
#设备/电池
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getBatteryInfo | 获取电池信息。 | 支持 | 不支持 |
| onBatteryInfoChange | 监听电池信息变化事件。 | 支持 | 不支持 |
#设备/电话
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| makePhoneCall | 拨打电话。 | 支持 | 支持 |
#设备/短信
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| sendSms | 拉起系统短信发送面板。 | 支持 | 支持 |
#设备/基础信息
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getDeviceInfo | 获取设备基础信息。 | 支持 | 支持 |
| getDeviceInfoSync | 同步获取设备基础信息。 | 支持 | 支持 |
#设备/加密
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getRandomValues | 获取安全随机数。 | 支持 | 不支持 |
#设备/加速度计
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| onAccelerometerChange | 监听加速度数据变化事件。 | 支持 | 不支持 |
| startAccelerometer | 开始监听加速度。 | 支持 | 不支持 |
| stopAccelerometer | 停止监听加速度。 | 支持 | 不支持 |
#设备/剪贴板
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getClipboardData | 获取剪贴板内容。 | 支持 | 支持 |
| setClipboardData | 设置系统剪贴板内容。 | 支持 | 支持 |
#设备/蓝牙
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| closeBLEConnection | 关闭 BLE 连接。 | 支持 | 不支持 |
| closeBluetoothAdapter | 关闭蓝牙适配器。 | 支持 | 不支持 |
| createBLEConnection | 创建 BLE 连接。 | 支持 | 不支持 |
| getBLEDeviceCharacteristics | 获取 BLE 特征值列表。 | 支持 | 不支持 |
| getBLEDeviceRSSI | 获取 BLE 设备 RSSI。 | 支持 | 不支持 |
| getBLEDeviceServices | 获取 BLE 服务列表。 | 支持 | 不支持 |
| getBLEMTU | 获取 BLE MTU。 | 支持 | 不支持 |
| getBluetoothAdapterState | 获取蓝牙适配器状态。 | 支持 | 不支持 |
| getBluetoothDevices | 获取当前蓝牙模块发现的设备列表。 | 支持 | 不支持 |
| getConnectedBluetoothDevices | 获取已连接的蓝牙设备列表。 | 支持 | 不支持 |
| isBluetoothDevicePaired | 查询蓝牙设备是否已经配对。 | 支持 | 不支持 |
| makeBluetoothPair | 发起蓝牙配对。 | 支持 | 不支持 |
| notifyBLECharacteristicValueChange | 订阅 BLE 特征值变化。 | 支持 | 不支持 |
| onBLECharacteristicValueChange | 注册 BLE 特征值变化回调。 | 支持 | 不支持 |
| onBLEConnectionStateChange | 注册 BLE 连接状态变化回调。 | 支持 | 不支持 |
| onBluetoothAdapterStateChange | 注册蓝牙适配器状态变化回调。 | 支持 | 不支持 |
| onBluetoothDeviceFound | 注册发现蓝牙设备回调。 | 支持 | 不支持 |
| openBluetoothAdapter | 打开蓝牙适配器。 | 支持 | 不支持 |
| readBLECharacteristicValue | 读取 BLE 特征值。 | 支持 | 不支持 |
| setBLEMTU | 设置 BLE MTU。 | 支持 | 不支持 |
| startBluetoothDevicesDiscovery | 开始搜索附近的蓝牙设备。 | 支持 | 不支持 |
| stopBluetoothDevicesDiscovery | 停止搜索附近的蓝牙设备。 | 支持 | 不支持 |
| writeBLECharacteristicValue | 写入 BLE 特征值。 | 支持 | 不支持 |
#设备/罗盘
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| onCompassChange | 监听罗盘数据变化事件。 | 支持 | 不支持 |
| startCompass | 开始监听罗盘。 | 支持 | 不支持 |
| stopCompass | 停止监听罗盘。 | 支持 | 不支持 |
#设备/屏幕
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| disableUserScreenRecord | 禁止用户录屏。 | 支持 | 不支持 |
| enableUserScreenRecord | 允许用户录屏。 | 支持 | 不支持 |
| getScreenBrightness | 获取屏幕亮度。 | 支持 | 不支持 |
| onUserCaptureScreen | 监听用户主动截屏事件。 | 支持 | 不支持 |
| onUserScreenRecord | 监听用户录屏事件。 | 支持 | 不支持 |
| setKeepScreenOn | 设置屏幕常亮状态。 | 支持 | 不支持 |
| setScreenBrightness | 设置屏幕亮度。 | 支持 | 不支持 |
#设备/日历
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| addPhoneCalendar | 向系统日历添加事件。 | 支持 | 支持 |
| addPhoneRepeatCalendar | 向系统日历添加重复事件。 | 支持 | 支持 |
| deletePhoneCalendar | 按标题和原始时间删除全部匹配的系统日历事件。 | 支持 | 支持 |
#设备/扫码
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| scanCode | 调起扫码能力。 | 支持 | 支持 |
#设备/设备方向
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| onDeviceMotionChange | 监听设备方向变化事件。 | 支持 | 不支持 |
| startDeviceMotionListening | 开始监听设备方向变化。 | 支持 | 不支持 |
| stopDeviceMotionListening | 停止监听设备方向变化。 | 支持 | 不支持 |
#设备/陀螺仪
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| onGyroscopeChange | 监听陀螺仪数据变化事件。 | 支持 | 不支持 |
| startGyroscope | 开始监听陀螺仪。 | 支持 | 不支持 |
| stopGyroscope | 停止监听陀螺仪。 | 支持 | 不支持 |
#设备/网络
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getNetworkType | 获取当前网络类型。 | 支持 | 不支持 |
| onNetworkStatusChange | 监听网络状态变化事件。 | 支持 | 不支持 |
#设备/无障碍
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| checkIsOpenAccessibility | 检测无障碍能力是否开启。 | 支持 | - |
#设备/震动
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| vibrateLong | 触发长震动。 | 支持 | 支持 |
| vibrateShort | 触发短震动。 | 支持 | 支持 |
#设备/iBeacon
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getBeacons | 获取已搜索到的 iBeacon 列表。 | 支持 | 不支持 |
| startBeaconDiscovery | 开始搜索附近的 iBeacon。 | 支持 | 不支持 |
| stopBeaconDiscovery | 停止搜索附近的 iBeacon。 | 支持 | 不支持 |
#设备/Wi-Fi
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| connectWifi | 连接指定 Wi-Fi。 | 支持 | 不支持 |
| getConnectedWifi | 获取当前已连接 Wi-Fi 信息。 | 支持 | 不支持 |
| getWifiList | 获取 Wi-Fi 列表。 | 支持 | 不支持 |
| onWifiConnected | 监听连接上 Wi-Fi 的事件。 | 支持 | 不支持 |
| setWifiList | 设置 Wi-Fi 预设列表(iOS 特有)。 | 支持 | 不支持 |
| startWifi | 初始化 Wi-Fi 模块。 | 支持 | 不支持 |
| stopWifi | 关闭 Wi-Fi 模块。 | 支持 | 不支持 |
#数据分析
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| reportEvent | 上报数据分析事件。 | 支持 | 支持 |
#网络
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| connectSocket | 创建一个 WebSocket 连接,并返回可操作该连接的 SocketTask。
该 API 会同步返回 | 支持 | 不支持 |
| downloadFile | 下载文件,并返回可取消、可监听进度的 DownloadTask。 | 支持 | 不支持 |
| request | 发起网络请求。
| 支持 | 支持 |
| uploadFile | 上传本地文件,并返回可用于监听进度和中断上传的 UploadTask。 | 支持 | 不支持 |
#文件系统
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| getFileSystemManager | 获取文件系统管理器。 | 支持 | 不支持 |
#自定义通信
| API | 说明 | 页面 | 卡片 |
|---|---|---|---|
| createCustomEvent | 创建一组用于发送和监听自定义事件的函数。 | 支持 | 支持 |