JSAPI 总览.md 45 KB
JSAPI 总览
更新于 2026-05-22
获取凭证
| API名称 | API说明 |
|---|---|
| getAuthCode | 获取小程序免登授权码 |
| requestAuthCode | 获取微应用免登授权码。 |
| getOperateAuthCode | 获取微应用反馈式操作的临时授权码 |
| requestAuthInfo | 唤起授权弹窗，获取用户授权 |
基础交互
网络
| 类目 | API名称 | API说明 |
|---|---|---|
| 网络请求 | httpRequest | 向指定服务器发起一个跨域 http(s) 请求 |
| 上传下载 | downloadFile | 下载文件资源到本地 |
| 上传下载 | uploadFile | 上传本地资源到开发者服务器 |
| WebSocket | closeSocket | 关闭WebSocket连接 |
| WebSocket | connectSocket | 创建一个 WebSocket 的连接 |
| WebSocket | onSocketOpen | 监听WebSocket连接打开事件 |
| WebSocket | offSocketOpen | 取消监听WebSocket连接打开事件 |
| WebSocket | onSocketError | 监听WebSocket错误 |
| WebSocket | offSocketError | 取消监听WebSocket错误 |
| WebSocket | onSocketClose | 监听WebSocket关闭 |
| WebSocket | offSocketClose | 取消监听WebSocket关闭事件 |
| WebSocket | offSocketMessage | 取消监听WebSocket接收到服务器的消息事件 |
| WebSocket | onSocketMessage | 监听WebSocket接收到服务器的消息事件 |
| WebSocket | sendSocketMessage | 通过WebSocket连接发送数据 |
基础
| API名称 | API说明 |
|---|---|
| canIUse | 判断 API 是否可用 |
| corpId | 获取当前访问用户的企业corpId |
| exit | 关闭钉钉小程序 |
| ExtSDKVersion | 使用本接口获取基础库版本号 |
| getRunScene | 获取当前小程序的运行版本 |
| getAppIdSync | 同步获取小程序的AppId，即MiniAppId |
| getLaunchOptionsSync | 获取小程序启动时的参数 |
| SDKVersion | 使用本接口获取基础库版本号 |
缓存
| API名称 | API说明 |
|---|---|
| clearStorage | 异步清除本地缓存数据 |
| clearStorageSync | 同步清除本地storage缓存的数据 |
| getStorage | 可以获取指定key的单条缓存数据 |
| getStorageInfo | 异步获取当前storage下所有缓存信息的key |
| getStorageSync | 同步获取缓存数据 |
| getStorageInfoSync | 同步获取当前storage下所有缓存信息的key、已占用空间大小和限制最大的缓存空间大小信息 |
| removeStorage | 删除缓存数据 |
| removeStorageSync | 同步删除缓存数据 |
| setStorage | 将数据存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的数据 |
| setStorageSync | 同步将数据存储在本地缓存中指定的 key 中 |
界面
| 类目 | API名称 | API说明 |
|---|---|---|
| 导航栏 | closePage | 关闭当前页面 |
| 导航栏 | goBackPage | 返回上一级页面 |
| 导航栏 | quitPage | PC端关闭页面 |
| 导航栏 | replacePage | 替换页面 |
| 导航栏 | setNavigationBar | 设置小程序导航栏样式及标题等 |
| 导航栏 | setNavigationTitle | 设置导航栏标题 |
| 导航栏 | setNavigationIcon | 标题栏添加问号图标 |
| 导航栏 | setNavigationLeft | 设置左侧导航按钮文本 |
| TabBar | addTabBarItem | 添加tabBar页面 |
| TabBar | hideTabBarRedDot | 隐藏tabBar红点 |
| TabBar | removeTabBarItem | 移除tabBar页面 |
| TabBar | removeTabBarBadge | 移除tabBar文本 |
| TabBar | setTabBarBadge | 为 tabBar 某一项的右上角添加文本 |
| TabBar | showTabBarRedDot | 显示tabBar红点 |
| TabBar | enableLeaveConfirm | 对当前页面进行离开二次确认 |
| 路由 | navigateTo | 跳转到应用内的某个指定页面 |
| 路由 | navigateBack | 返回上一级或返回多级页面 并且关闭当前页面 |
| 路由 | reLaunch | 跳转到小程序应用内指定页面并且关闭当前所有页面 |
| 路由 | redirectTo | 跳转到应用内的某个指定页面 |
| 路由 | switchTab | 跳转到指定 tabBar 页面 |
| 动画 | createAnimation | 创建动画实例 |
| 动画 | Animation.bottom | 设置动画实例bottom值 |
| 动画 | Animation.backgroundColor | 设置动画背景色 |
| 动画 | Animation.height | 设置动画实例高度值 |
| 动画 | Animation.left | 设置动画实例Left值 |
| 动画 | Animation.matrix | 设置动画实例Matrix值 |
| 动画 | Animation.matrix3d | 设置动画实例Matrix3d |
| 动画 | Animation.opacity | 设置动画透明度 |
| 动画 | Animation.right | 设置动画实例Right值 |
| 动画 | Animation.rotate | 设置动画实例旋转Rotate值 |
| 动画 | Animation.rotateX | 设置动画实例RotateX值 |
| 动画 | Animation.rotateY | 设置动画实例RotateY值 |
| 动画 | Animation.rotateZ | 设置动画实例RotateZ值 |
| 动画 | Animation.rotate3d | 设置动画实例Rotate3D值 |
| 动画 | Animation.scale | 设置动画实例Scale值 |
| 动画 | Animation.scaleX | 设置动画实例ScaleX值 |
| 动画 | Animation.scaleY | 设置动画实例ScaleY值 |
| 动画 | Animation.scaleZ | 设置动画实例ScaleZ值 |
| 动画 | Animation.scale3d | 设置动画实例Scale3d值 |
| 动画 | Animation.skew | 设置动画实例Skew |
| 动画 | Animation.skewX | 设置动画实例SkewX |
| 动画 | Animation.skewY | 设置动画实例SkewY |
| 动画 | Animation.top | 设置动画实例Top值 |
| 动画 | Animation.translate | 设置动画实例Translate |
| 动画 | Animation.translateX | 设置动画实例TranslateX值 |
| 动画 | Animation.translateY | 设置动画实例TranslateY值 |
| 动画 | Animation.translateZ | 设置动画实例TranslateZ值 |
| 动画 | Animation.translate3d | 设置动画实例Translate3d值 |
| 动画 | Animation.width | 设置动画实例长度值 |
| 画布 | createCanvasContext | 创建canvas绘图上下文 |
| 画布 | CanvasContext.arc | 画一条弧线 |
| 画布 | CanvasContext.addColorStop | 创建渐变点 |
| 画布 | CanvasContext.beginPath | 创建一个路径 |
| 画布 | CanvasContext.bezierCurveTo | 创建三次方贝塞尔曲线路径 |
| 画布 | CanvasContext.clip | 创建的路径设置为当前剪切路径 |
| 画布 | CanvasContext.clearRect | 清除画布上在该矩形区域内的内容 |
| 画布 | CanvasContext.closePath | 关闭一个路径 |
| 画布 | CanvasContext.createLinearGradient | 创建一个线性的渐变色 |
| 画布 | CanvasContext.createCircularGradient | 创建一个圆形的渐变色 |
| 画布 | CanvasContext.draw | 在绘图上下文中的描述（路径、变形、样式）画到 canvas 中 |
| 画布 | CanvasContext.drawImage | 绘制图像 |
| 画布 | CanvasContext.fill | 对当前路径中的内容进行填充 |
| 画布 | CanvasContext.fillRect | 填充矩形 |
| 画布 | CanvasContext.fillText | 在画布上绘制被填充的文本 |
| 画布 | CanvasContext.getImageData | 获取canvas区域隐含的像素数据 |
| 画布 | CanvasContext.lineTo | 创建一条从上次指定点到目标点的线 |
| 画布 | CanvasContext.moveTo | 将路径移动到画布中的指定点 |
| 画布 | CanvasContext.putImageData | 将像素数据绘制到画布 |
| 画布 | CanvasContext.quadraticCurveTo | 创建二次贝塞尔曲线路径 |
| 画布 | CanvasContext.rect | 创建一个矩形 |
| 画布 | CanvasContext.rotate | 以原点为中心（原点可以用translate方法修改），顺时针旋转当前坐标轴。多次调用rotate，旋转的角度会叠加 |
| 画布 | CanvasContext.restore | 恢复之前保存的绘图上下文 |
| 画布 | CanvasContext.save | 保存当前的绘图上下文 |
| 画布 | CanvasContext.scale | 调用scale方法后，之后创建的路径其横纵坐标会被缩放。多次调用scale，倍数会相乘 |
| 画布 | CanvasContext.stroke | 画出当前路径的边框 |
| 画布 | CanvasContext.strokeRect | 画一个非填充矩形 |
| 画布 | CanvasContext.setFillStyle | 设置填充色 |
| 画布 | CanvasContext.setFontSize | 设置字体大小 |
| 画布 | CanvasContext.setShadow | 设置阴影样式 |
| 画布 | CanvasContext.setLineCap | 设置线条的端点样式 |
| 画布 | CanvasContext.setLineJoin | 设置线条的交点样式 |
| 画布 | CanvasContext.setTextAlign | 设置文本的对齐方式 |
| 画布 | CanvasContext.setMiterLimit | 设置最大斜接长度 |
| 画布 | CanvasContext.setLineWidth | 设置线条的宽度 |
| 画布 | CanvasContext.setStrokeStyle | 设置边框颜色 |
| 画布 | CanvasContext.setGlobalAlpha | 设置全局画笔透明度 |
| 画布 | CanvasContext.setTextBaseline | 设置当前文本基线的属性 |
| 画布 | CanvasContext.translate | 对当前坐标系的原点(0, 0)进行变换，默认的坐标系原点为页面左上角 |
| 画布 | CanvasContext.toTempFilePath | 画布内容导出成图片 |
| 字体 | loadFontFace | 动态的加载网络字体 |
| 地图 | chooseDistrict | 选择地区 |
| 地图 | createMapContext | 创建并返回一个地图上下文对象 |
| 地图 | MapContext.clearRoute | 清除地图上的步行导航路线 |
| 地图 | MapContext.changeMarkers | 用于添加、删除、更新指定的标记 |
| 地图 | MapContext.calculateDistance | 提供地图路径计算能力，用于计算途径地图上多个点的总路线距离 |
| 地图 | MapContext.getRegion | 获取地图东北角、西南角的经纬度，从而获取地图整体的视野范围 |
| 地图 | MapContext.gestureEnable | 设置所有手势是否可用 |
| 地图 | MapContext.getMapProperties | 获取地图的属性信息 |
| 地图 | MapContext.getCenterLocation | 获取当前地图中心位置 |
| 地图 | MapContext.moveToLocation | 将视野移动到定位点并恢复到默认缩放级别 |
| 地图 | MapContext.showRoute | 规划默认步行路线，只能显示一条 |
| 地图 | MapContext.showsScale | 设置比例尺控件是否可见 |
| 地图 | MapContext.showsCompass | 设置指南针是否可见 |
| 地图 | MapContext.smoothMoveMarker | 指定标记（marker）进行动画 |
| 地图 | MapContext.smoothMovePolyline | 用于轨迹动画 |
| 地图 | MapContext.translateMarker | 用于平移点标记 |
| 地图 | MapContext.updateComponents | 用于增量更新地图 |
| 滚动 | pageScrollTo | 滚动到页面的目标位置 |
| 交互反馈 | alert | 显示警告框 |
| 交互反馈 | confirm | 显示确认框 |
| 交互反馈 | hideToast | 隐藏弱提示 |
| 交互反馈 | hideLoading | 隐藏加载提示 |
| 交互反馈 | prompt | 弹出输出入对话框 |
| 交互反馈 | showModal | 增强版modal弹浮层 |
| 交互反馈 | showToast | 显示一个弱提示 |
| 交互反馈 | showLoading | 显示加载提示 |
| 交互反馈 | showActionSheet | 显示操作菜单 |
| 下拉刷新 | disablePullDownRefresh | 禁用下拉刷新 |
| 下拉刷新 | enablePullDownRefresh | 启用下拉刷新 |
| 下拉刷新 | onPullDownRefresh | 监听下拉刷新 |
| 下拉刷新 | stopPullDownRefresh | 停止当前页面的下拉刷新 |
| 键盘输入 | hideKeyboard | 隐藏键盘 |
| 键盘输入 | onKeyboardHide | 监听键盘收起 |
| 键盘输入 | onKeyboardShow | 监听键盘弹起事件 |
| 节点查询 | createIntersectionObserver | 创建并返回一个IntersectionObserver对象实例 |
| 节点查询 | IntersectionObserver.disconnect | 停止监听 |
| 节点查询 | IntersectionObserver.observe | 指定目标节点并开始监听相交状态变化情况 |
| 节点查询 | IntersectionObserver.relativeTo | 使用选择器指定一个节点，作为参照区域之一 |
| 节点查询 | IntersectionObserver.relativeToViewport | 指定页面显示区域作为参照区域之一 |
| 节点查询 | createSelectorQuery | 创建一个节点查询对象SelectorQuery |
| 节点查询 | SelectorQuery.boundingClientRect | 将当前选择节点的位置信息放入查询结果， 返回对象包含 width/height/left/top/bottom/right |
| 节点查询 | SelectorQuery.exec | 查询结果放入 callback 回调中 |
| 节点查询 | SelectorQuery.select | 选择当前第一个匹配选择器的节点，选择器支持 id 选择器以及 class 选择器 |
| 节点查询 | SelectorQuery.selectAll | 选择所有匹配选择器的节点，选择器支持 id 选择器以及 class 选择器 |
| 节点查询 | SelectorQuery.scrollOffset | 将当前选择节点的滚动信息放入查询结果，返回对象包含 scrollTop/scrollLeft |
| 节点查询 | SelectorQuery.selectViewport | 选择窗口对象 |
| 暗黑模式 | getColorSchemeSync | 获取钉钉当前显示模式。返回当前系统的显示模式"light" 或 "dark" |
| 选择日期 | chooseDateTime | 选择日期和时间 |
| 选择日期 | chooseOneDayInCalendar | 月历组件，选择某天 |
| 选择日期 | chooseHalfDayInCalendar | 月历组件，选择半天 |
| 选择日期 | datePicker | 打开日期选择列表 |
| 选择日期 | dateRangePicker | 月历组件，选择日期区间 |
| 选择日期 | timePicker | 时间选择器 |
| 选项选择器 | multiSelect | 多选组件 |
| 选项选择器 | singleSelect | 单选组件 |
跳转
| API名称 | API说明 |
|---|---|
| isInTabWindow | 判断当前页面是否为弹窗页面 |
| navigateToPage | 跳转到另一个钉钉H5微应用 |
| navigateBackPage | 返回上一个应用 |
| navigateToMiniProgram | 跳转到其他钉钉小程序 |
| navigateBackMiniProgram | 返回到上一个钉钉小程序 |
| openLink | 打开目标页面 |
| openMicroApp | 打开应用 |
| openPageInMicroApp | 打开应用内页面 |
| openPageInModalForPC | 打开模态框 |
| openPageInSlidePanelForPC | 打开侧边面板 |
| openPageInWorkBenchForPC | PC端打开新弹窗页面 |
分享
| API名称 | API说明 |
|---|---|
| onShareAppMessage | 自定义该页面的分享内容 |
| share | 实现分享功能 |
| showSharePanel | 唤起H5或小程序分享面板的API |
更新管理
| API名称 | API说明 |
|---|---|
| getUpdateManager | 用来管理小程序更新 |
| UpdateManager.applyUpdate | 强制小程序重启并使用新版本 |
| UpdateManager.onUpdateFailed | 监听小程序更新失败事件 |
| UpdateManager.onUpdateReady | 监听小程序有版本更新事件 |
| UpdateManager.onCheckForUpdate | 监听向钉钉后台请求检查更新结果事件 |
多媒体
| 类目 | API名称 | API说明 |
|---|---|---|
| 图片 | chooseImage | 拍照或从本地相册选择图片 |
| 图片 | compressImage | 压缩图片 |
| 图片 | editPicture | 编辑图片 |
| 图片 | getImageInfo | 获取图片信息 |
| 图片 | previewImage | 预览图片 |
| 图片 | saveImage | 保存在线、本地临时或者永久地址图片到手机相册 |
| 图片 | saveImageToPhotosAlbum | 保存图片到系统相册 |
| 图片 | chooseMedia | 拍摄或从手机相册中选择图片或视频 |
| 录音 | downloadAudio | 下载音频 |
| 录音 | onRecordEnd | 监听录音自动停止 |
| 录音 | onPlayAudioEnd | 监听播放自动停止 |
| 录音 | playAudio | 播放语音 |
| 录音 | pauseAudio | 暂停播放语音 |
| 录音 | resumeAudio | 恢复暂停播放的语音 |
| 录音 | stopRecord | 停止录音 |
| 录音 | startRecord | 开始录音 |
| 录音 | stopAudio | 停止播放音频 |
| 录音 | translateVoice | 语音转文字 |
| 录音 | getRecorderManager | 获取当前小程序全局唯一的录音管理器 |
| 录音 | RecorderManager.onstart | 录音开始时的回调 |
| 录音 | RecorderManager.onstop | 录音停止时的回调 |
| 录音 | RecorderManager.onerror | 录音管理监听错误 |
| 录音 | RecorderManager.onpause | 录音管理监听暂停 |
| 录音 | RecorderManager.onresume | 录音管理监听继续 |
| 录音 | RecorderManager.onframerecorded | 录音管理监听已录制完制定帧大小的文件 |
| 录音 | RecorderManager.pause | 录音管理暂停录音 |
| 录音 | RecorderManager.resume | 录音管理继续录音 |
| 录音 | RecorderManager.stop | 停止录音 |
| 录音 | RecorderManager.start | 开始录音 |
| 音频 | getBackgroundAudioManager | 获取当前小程序全局唯一的背景音频管理 |
| 音频 | BackgroundAudioManager.onPlay | 监听背景音频播放事件 |
| 音频 | BackgroundAudioManager.onStop | 监听背景音频停止事件 |
| 音频 | BackgroundAudioManager.onPause | 监听背景音频暂停事件 |
| 音频 | BackgroundAudioManager.onEnded | 监听背景音频结束事件 |
| 音频 | BackgroundAudioManager.onPrev | 监听用户在系统音乐播放面板点击上一曲事件 |
| 音频 | BackgroundAudioManager.onNext | 监听用户在系统音乐播放面板点击下一曲事件 |
| 音频 | BackgroundAudioManager.onCanplay | 监听背景音频进入可以播放事件 |
| 音频 | BackgroundAudioManager.onSeeked | 监听背景音频完成播放进度跳转操作事件 |
| 音频 | BackgroundAudioManager.onSeeking | 监听背景音频开始播放进度跳转事件 |
| 音频 | BackgroundAudioManager.onWaiting | 监听音频加载中事件。 |
| 音频 | BackgroundAudioManager.onTimeUpdate | 监听背景音频播放进度更新事件 |
| 音频 | BackgroundAudioManager.play | 播放背景音乐 |
| 音频 | BackgroundAudioManager.pause | 暂停背景音频 |
| 音频 | BackgroundAudioManager.stop | 停止播放背景音乐 |
| 音频 | BackgroundAudioManager.seek | 跳转到指定位置position |
| 音频 | onAudioInterruptionEnd | 监听音频被中断的结束事件。 |
| 音频 | onAudioInterruptionBegin | 监听音频因为系统占用而被中断的开始事件 |
| 音频 | saveVideoToPhotosAlbum | 保存视频到系统相册 |
| 视频 | chooseVideo | 拍摄视频或从手机相册中选视频 |
| 视频 | createVideoContext | 创建并返回一个 video上下文对象videoContext |
| 视频 | VideoContext.exitFullScreen | 控制相应video组件的全屏退出 |
| 视频 | VideoContext.mute | 切换静音状态 |
| 视频 | VideoContext.play | 控制相应video组件的播放 |
| 视频 | VideoContext.pause | 控制相应video组件的暂停 |
| 视频 | VideoContext.playbackRate | 设置倍速播放 |
| 视频 | VideoContext.requestFullScreen | 控制相应video组件的全屏进入 |
| 视频 | VideoContext.stop | 控制相应video组件的终止 |
| 视频 | VideoContext.seek | 控制相应video组件的定位 |
| 视频 | VideoContext.snapshot | 控制相应video组件的截图 |
DING
| API名称 | API说明 |
|---|---|
| createDing | 发起DING |
| createDingForPC | 发起PC端发钉 |
通讯录
| API名称 | API说明 |
|---|---|
| complexChoose | 选择人和部门 |
| chooseStaffForPC | PC端选择企业内部的人 |
| choosePhonebook | 选取用户手机联系人 |
| chooseDepartments | 选择部门 |
| chooseUserFromList | 选取单个自定义联系人 |
| chooseExternalUsers | 选择外部联系人 |
| editExternalUser | 编辑外部联系人 |
音频会议
| API名称 | API说明 |
|---|---|
| makeVideoConfCall | 发起视频会议 |
办公电话
| API名称 | API说明 |
|---|---|
| callUsers | 拨打钉钉电话 |
| checkBizCall | 检查某企业办公电话开通状态 |
| getCloudCallInfo | 查询企业是否已开办公电话 |
| getCloudCallList | 查询话单列表 |
| makeCloudCall | 发起办公电话呼叫 |
| quickCallList | 拨打单人电话选项 |
| showCallMenu | 唤起拨打电话菜单 |
会话管理
| API名称 | API说明 |
|---|---|
| chooseChat | 选择会话 |
| openChatByChatId | 打开对应会话 |
| openChatByUserId | 打开与某个用户的聊天页面 |
| openChatByConversationId | 跳转到对应会话 |
位置
| API名称 | API说明 |
|---|---|
| getLocation | 获取用户当前的地理位置信息 |
| getLocatingStatus | 批量获取连续定位状态 |
| locateInMap | 地图定位 |
| openLocation | 使用内置地图查看位置 |
| searchMap | 唤起地图页面 |
| stopLocating | 停止连续定位 |
| startLocating | 连续获取当前地理位置信息（持续定位） |
文件储存
钉盘
| API名称 | API说明 |
|---|---|
| chooseDingTalkDir | 唤起钉盘选择器 |
| previewFileInDingTalk | 预览钉盘文件 |
| previewImagesInDingTalkBatch | 批量预览钉盘图片 |
| saveFileToDingTalk | 转存文件到钉盘 |
| uploadAttachmentToDingTalk | 上传附件到钉盘，或从钉盘选择文件 |
文件
| API名称 | API说明 |
|---|---|
| isLocalFileExist | 批量检测本地文件是否存在 |
| openLocalFile | 打开本地文件 |
| getFileSystemManager | 获取FileSystemManager文件管理器 |
| FileSystemManager.access | 判断文件或者目录是否存在 |
| FileSystemManager.appendFile | 向本地用户文件末尾添加内容 |
| FileSystemManager.copyFile | 复制文件保存到本地用户目录 |
| FileSystemManager.getFileInfo | 获取本地临时文件、本地缓存文件和本地用户文件的信息 |
| FileSystemManager.getSavedFileList | 获取本地缓存文件列表 |
| FileSystemManager.mkdir | 创建本地用户目录 |
| FileSystemManager.rmdir | 删除本地用户文件目录 |
| FileSystemManager.rename | 重命名本地用户文件或目录的名称并且可以移动到新目录下 |
| FileSystemManager.readdir | 获取本地用户文件列表 |
| FileSystemManager.readFile | 读取本地用户文件的内容 |
| FileSystemManager.removeSavedFile | 删除本地缓存文件 |
| FileSystemManager.stat | 获取文件或目录的status对象 |
| FileSystemManager.saveFile | 本地临时文件保存为本地缓存文件或本地用户文件 |
| FileSystemManager.unzip | 解压本地用户文件 |
| FileSystemManager.unlink | 删除本地用户文件 |
| FileSystemManager.writeFile | 向本地用户目录内写入文件 |
移动支付
| API名称 | API说明 |
|---|---|
| pay | 完成支付 |
设备能力
| 类目 | API名称 | API说明 |
|---|---|---|
| UUID | getDeviceUUID | 获取uuid |
| 系统信息 | checkAuth | 检查手机权限授权状态 |
| 系统信息 | getSystemInfo | 获取手机系统信息 |
| 系统信息 | getSystemSettings | 打开系统设置 |
| 系统信息 | getSystemInfoSync | 获取手机系统信息的同步接口 |
| 系统信息 | isScreenReaderEnabled | 判断是否开启无障碍模式 |
| 系统信息 | rsa | 实现rsa加解密 |
| 系统信息 | showAuthGuide | 授权引导 |
| 网络状态 | getNetworkType | 获取当前网络状态 |
| 网络状态 | getWifiHotspotStatus | 获取热点接入信息 |
| Wi-Fi | connectWifi | 连接 Wi-Fi |
| Wi-Fi | getWifiList | 获取 Wi-Fi 列表 |
| Wi-Fi | getWifiStatus | 获取wifi状态 |
| Wi-Fi | getConnectedWifi | 获取已连接 Wi-Fi 信息 |
| Wi-Fi | onGetWifiList | 监听获取到 Wi-Fi 列表事件 |
| Wi-Fi | offGetWifiList | 停止监听已获取 Wi-Fi 列表数据事件 |
| Wi-Fi | onWifiConnected | 监听连接上 Wi-Fi 事件 |
| Wi-Fi | offWifiConnected | 停止监听连接 Wi-Fi 事件 |
| Wi-Fi | registerSSID | 信任该 SSID(iOS) |
| Wi-Fi | stopWifi | 关闭 Wi-Fi 模块 |
| Wi-Fi | startWifi | 初始化 Wi-Fi 模块 |
| Wi-Fi | unregisterSSID | 不再信任该 SSID(iOS) |
| Wi-Fi | setWifiList | 设置入参中 wifiList 的 AP 相关信息 |
| 剪贴板 | getClipboard | 获取系统剪贴板的内容 |
| 剪贴板 | setClipboard | 设置剪切板数据 |
| 振动 | vibrate | 使用振动功能 |
| 振动 | vibrateLong | 使用长振动功能 |
| 振动 | vibrateShort | 使用短振动功能 |
| 低功耗蓝牙 | connectBLEDevice | 连接低功耗蓝牙设备 |
| 低功耗蓝牙 | disconnectBLEDevice | 断开与低功耗蓝牙设备的连接 |
| 低功耗蓝牙 | getBLEDeviceServices | 获取蓝牙设备所有服务 |
| 低功耗蓝牙 | getBLEDeviceCharacteristics | 获取蓝牙设备所有特征值 |
| 低功耗蓝牙 | notifyBLECharacteristicValueChange | 启用低功耗蓝牙设备特征值变化时的notify功能 |
| 低功耗蓝牙 | onBLEConnectionStateChanged | 监听低功耗蓝牙连接的错误事件，包括设备丢失，连接异常断开等 |
| 低功耗蓝牙 | offBLEConnectionStateChanged | 移除低功耗蓝牙连接状态变化事件的监听 |
| 低功耗蓝牙 | onBLECharacteristicValueChange | 监听低功耗蓝牙设备的特征值变化的事件 |
| 低功耗蓝牙 | offBLECharacteristicValueChange | 移除低功耗蓝牙设备的特征值变化事件的监听 |
| 低功耗蓝牙 | readBLECharacteristicValue | 读取低功耗蓝牙设备特征值中的数据 |
| 低功耗蓝牙 | writeBLECharacteristicValue | 向低功耗蓝牙设备特征值中写入数据 |
| 传统蓝牙 | closeBluetoothAdapter | 关闭本机蓝牙模块 |
| 传统蓝牙 | getBluetoothDevices | 获取所有已发现的蓝牙设备 |
| 传统蓝牙 | getBluetoothAdapterState | 获取本机蓝牙模块状态 |
| 传统蓝牙 | getConnectedBluetoothDevices | 获取处于已连接状态的设备 |
| 传统蓝牙 | onBluetoothDeviceFound | 搜索到新的蓝牙设备时触发此事件 |
| 传统蓝牙 | offBluetoothDeviceFound | 移除寻找到新的蓝牙设备事件的监听 |
| 传统蓝牙 | onBluetoothAdapterStateChange | 监听本机蓝牙状态变化的事件 |
| 传统蓝牙 | offBluetoothAdapterStateChange | 停止监听本机蓝牙状态变化的事件 |
| 传统蓝牙 | openBluetoothAdapter | 初始化小程序蓝牙模块 |
| 传统蓝牙 | stopBluetoothDevicesDiscovery | 停止搜寻附近的蓝牙外围设备 |
| 传统蓝牙 | startBluetoothDevicesDiscovery | 开始搜寻附近的蓝牙外围设备 |
| 扫码 | scanCard | 扫名片 |
| 扫码 | scan | 扫一扫功能 |
| NFC | readNFC | 读取NFC芯片内容 |
| NFC | writeNFC | 实现NFC数据写入 |
| 摇一摇 | clearShake | 停止摇一摇 |
| 摇一摇 | watchShake | 启动摇一摇 |
| 屏幕亮度 | getScreenBrightness | 获取屏幕亮度 |
| 屏幕亮度 | setScreenBrightness | 设置屏幕亮度 |
| 屏幕亮度 | setKeepScreenOn | 设置屏幕常亮 |
| 拨打电话 | addPhoneContact | 添加手机联系人 |
| 设备电量 | getBatteryInfo | 获取设备电量 |
| 设备方向 | rotateScreenView | 旋转屏幕 |
| 设备方向 | resetScreenView | 重置旋转屏幕 |
| 内存不足处理 | removeCachedAPIResponse | 删除已缓存的JSAPI返回值 |
| 内存不足处理 | getCachedAPIResponse | 获取已缓存的JSAPI返回值 |
| 内存不足处理 | enableAPIResponseCache | 开启JSAPI返回值缓存 |
| 内存不足处理 | getPageTerminateInfo | 获取WebView崩溃信息 |
专属开放
| API名称 | API说明 |
|---|---|
| exclusiveLiveCheck | 专属实人认证 |
| getUserExclusiveInfo | 获取钉钉客户端是否为专属钉钉 |
DingTalk A1
| API名称 | API说明 |
|---|---|
| startDingerRecord | DingTalk A1 发起录音 |
| stopDingerRecord | DingTalk A1 停止录音 |
| getDingerDeviceStatus | 查询 DingTalk A1 设备状态 |