《钉钉应用开发者速成手册》之“钉钉能力概览——H5微应用JSAPI”

分类

接口说明

JSAPI名称

是否需鉴权

Android

iOS

PC

容器

获取容器版本号

dd.version

不需要

支持

支持

不支持

弹窗

alert

device.notification.alert

不需要

支持

支持

支持

confirm

device.notification.confirm

不需要

支持

支持

支持

prompt

device.notification.prompt

不需要

支持

支持

支持

手机震动

device.notification.vibrate

不需要

支持

支持

不支持

toast

device.notification.toast

不需要

支持

支持

支持

actionSheet

device.notification.actionSheet

不需要

支持

支持

支持

显示加载

device.notification.showPreloader

不需要

支持

支持

不支持

隐藏加载

device.notification.hidePreloader

不需要

支持

支持

不支持

modal弹浮层

device.notification.modal

不需要

支持

支持

不支持

extendModal

device.notification.extendModal

不需要

支持

支持

不支持

多选组件

biz.util.multiSelect

不需要

支持

支持

不支持

摇一摇

启动摇一摇

device.accelerometer.watchShake

不需要

支持

支持

不支持

停止摇一摇

device.accelerometer.clearShake

不需要

支持

支持

不支持

设备

获取网络类型

device.connection.getNetworkType

不需要

支持

支持

不支持

获取Wifi状态

device.base.getWifiStatus

不需要

支持

支持

不支持

获取手机基础信息

device.base.getPhoneInfo

不需要

支持

支持

不支持

获取uuid

device.base.getUUID

需要

支持

支持

不支持

获取热点接入信息

device.base.getInterface

需要

支持

支持

不支持

读取NFC芯片内容

device.nfc.nfcRead

不需要

支持

不支持

不支持

NFC数据写入

device.nfc.nfcWrite

需要

支持

不支持

不支持

日期&月历

日期选择器

biz.util.datepicker

不需要

支持

支持

不支持

时间选择器

biz.util.timepicker

不需要

支持

支持

不支持

日期及时间选择器

biz.util.datetimepicker

不需l要

支持

支持

不支持

月历组件，选择某天

biz.calendar.chooseOneDay

不需要

支持

支持

不支持

月历组件，选择某时间

biz.calendar.chooseDateTime

不需要

支持

支持

不支持

月历组件，选择半天

biz.calendar.chooseHalfDay

不需要

支持

支持

不支持

月历组件，选择日期区间

biz.calendar.chooseInterval

不需要

支持

支持

不支持

导航栏

设置导航栏颜色

拼接dd_nav_bgcolor参数

不需要

支持

支持

不支持

微应用页面支持横屏

拼接dd_orientation参数

不需要

支持

支持

不支持

隐藏导航栏右侧按钮

拼接showmenu=false参数

不需要

支持

支持

不支持

设置左侧导航按钮文本

biz.navigation.setLeft

不需要

不支持

支持

支持

PC端左侧按钮点击事件

addEventListener

不需要

不支持

不支持

支持

PC端左侧按钮点击事件，移除监听回调函数

removeEventListener

不需要

不支持

不支持

支持

设置导航栏标题

biz.navigation.setTitle

不需要

支持

支持

支持

标题栏添加问号Icon

biz.navigation.setIcon

不需要

支持

支持

不支持

返回上一级页面

biz.navigation.goBack

不需要

支持

支持

不支持

关闭当前页面

biz.navigation.close

不需要

支持

支持

不支持

设置导航栏右侧单个按钮

biz.navigation.setRight

不需要

支持

支持

不支持

设置导航栏右侧多个按钮

biz.navigation.setMenu

不需要

支持

支持

不支持

自定义下拉菜单按钮图片

biz.navigation.setMenu

不需要

支持

支持

不支持

替换页面

biz.navigation.replace

不需要

支持

支持

不支持

关闭页面

biz.navigation.quit

不需要

不支持

不支持

支持

UI控件

输入框

ui.input.plain

不需要

支持

支持

不支持

设置顶部进度条颜色

ui.progressBar.setColors

不需要

支持

支持

不支持

启用下拉刷新

ui.pullTorefresh.enable

不需要

支持

支持

不支持

禁用下拉刷新

ui.pullToRefresh.disable

不需要

支持

支持

不支持

收起下拉刷新

ui.pullToRefresh.stop

不需要

支持

支持

不支持

禁用iOS WebView弹性效果

ui.webViewBounce.disable

不需要

不支持

支持

不支持

启用iOS WebView弹性效果

ui.webViewBounce.enable

不需要

不支持

支持

不支持

获取免登授权码

获取微应用免登授权码

runtime.permission.requestAuthCode

不需要

支持

支持

支持

获取服务窗免登授权码

channel.permission.requestAuthCode

不需要

支持

支持

支持

获取微应用反馈式操作的临时授权码

runtime.permission.requestOperateAuthCode

需要

支持

支持

支持

扫码

扫条形码、二维码

biz.util.scan

不需要

支持

支持

不支持

扫名片

biz.util.scanCard

需要

支持

支持

不支持

存储

设置存储信息

util.domainStorage.setItem

不需要

支持

支持

不支持

获取存储信息

util.domainStorage.getItem

不需要

支持

支持

不支持

删除存储信息

util.domainStorage.removeItem

不需要

支持

支持

不支持

地图

获取当前地理位置信息(单次定位)

device.geolocation.get

需要

支持

支持

不支持

连续获取当前地理位置信息(持续定位)

device.geolocation.start

需要

支持

支持

不支持

停止连续定位

device.geolocation.stop

需要

支持

支持

不支持

批量连续定位状态

device.geolocation.status

不需要

支持

支持

不支持

地图定位

biz.map.locate

需要

支持

支持

不支持

地图页面支持搜索

biz.map.search

需要

支持

支持

不支持

展示位置

biz.map.view

需要

支持

支持

不支持

业务

分享

biz.util.share

不需要

支持

支持

不支持

下拉控件

biz.util.chosen

不需要

支持

支持

不支持

复制到粘贴板

biz.clipboardData.setData

需要

支持

支持

不支持

打开应用

biz.microApp.openApp

不需要

支持

支持

不支持

文件

批量检测文件是否存在

biz.util.isLocalFileExist

不需要

不支持

不支持

支持

打开本地文件

biz.util.openLocalFile

不需要

不支持

不支持

支持

下载文件

biz.util.downLoadFile

不需要

不支持

不支持

支持

图片

图片预览

biz.util.previewImage

不需要

支持

支持

支持

打开新页面

打开应用内页面

biz.util.open

需要

支持

支持

支持

在新窗口上打开链接

biz.util.openLink

不需要

支持

支持

支持

打开模态框

biz.util.openModal

不需要

不支持

不支持

支持

打开侧边面板

biz.util.openSlidePanel

不需要

不支持

不支持

支持

电话

拨打钉钉电话

biz.telephone.call

需要

支持

支持

不支持

通用电话拨打

biz.telephone.showCallMenu

需要

支持

支持

不支持

检查某企业下的办公电话开通状态

biz.telephone.checkBizCall

需要

支持

支持

不支持

拨打单人电话选项 (可定制)

biz.telephone.quickCallList

需要

支持

支持

支持

发钉

DING 2.0发钉

biz.ding.create

需要

支持

支持

支持

DING 1.0发钉

biz.ding.post

需要

不支持

不支持

支持

通讯录选人

PC端选择企业内部的人

biz.contact.choose

需要

不支持

不支持

支持

选取手机通讯录

biz.contact.chooseMobileContacts

需要

支持

支持

不支持

选择部门和人

biz.contact.complexPicker

需要

支持

支持

支持

选择部门信息

biz.contact.departmentsPicker

需要

支持

支持

支持

创建企业群聊天

biz.contact.createGroup

需要

支持

支持

不支持

设置规则选人

biz.contact.setRule

需要

支持

支持

不支持

外部联系人

选择外部联系人

biz.contact.externalComplexPicker

需要

不支持

不支持

支持

编辑外部联系人

biz.contact.externalEditForm

需要

不支持

不支持

支持

自定义联系人

单选自定义联系人

biz.customContact.choose

需要

支持

支持

支持

多选自定义联系人

biz.customContact.multipleChoose

需要

支持

支持

支持

会话

获取会话信息

biz.chat.pickConversation

需要

支持

支持

不支持

根据corpid选择会话

biz.chat.chooseConversationByCorpId

需要

支持

支持

不支持

打开与某个用户的单聊会话

biz.chat.openSingleChat

需要

支持

支持

不支持

根据chatid跳转到对应会话

biz.chat.toConversation

需要

支持

支持

不支持

钉盘

保存文件到钉盘

biz.cspace.saveFile

需要

支持

支持

不支持

预览钉盘文件

biz.cspace.preview

需要

支持

支持

支持

选取钉盘目录

biz.cspace.chooseSpaceDir

需要

支持

支持

不支持

上传附件到钉盘/从钉盘选择文件

biz.util.uploadAttachment

需要

支持

支持

支持

音频接口

开始录音

device.audio.startRecord

需要

支持

支持

不支持

停止录音

device.audio.stopRecord

需要

支持

支持

不支持

监听录音自动停止

device.audio.onRecordEnd

需要

支持

支持

不支持

下载音频

device.audio.download

需要

支持

支持

不支持

播放语音

device.audio.play

需要

支持

支持

不支持

暂停播放语音

device.audio.pause

需要

支持

支持

不支持

恢复暂停播放的语音

device.audio.resume

需要

支持

支持

不支持

停止播放音频

device.audio.stop

需要

支持

支持

不支持

监听播放自动停止

device.audio.onPlayEnd

需要

支持

支持

不支持

语音转文字

device.audio.translateVoice

需要

支持

支持

不支持

视频会议

发起视频会议

biz.conference.videoConfCall

需要

支持

支持

支持

在线课堂

发起在线课堂

biz.live.startClassRoom

需要

不支持

不支持

支持

支付

支付接口

biz.alipay.pay

需要

支持

支持

不支持

数据加解密

数据加密

biz.util.encrypt

需要

支持

支持

不支持

数据解密

biz.util.decrypt

需要

支持

支持

不支持

转屏横屏

微应用页面支持转屏

拼接dd_orientation=auto参数

不需要

支持

支持

不支持

微应用页面支持横屏

拼接dd_orientation参数

不需要

支持

支持

不支持

微应用页面全屏展示

拼接dd_full_screen=true参数

不需要

支持

支持

不支持

微应用页面导航栏透明

拼接dd_nav_translucent=true参数

不需要

支持

支持

不支持

旋转屏幕

device.screen.rotateView

不需要

支持

支持

不支持

重置旋转屏幕

device.screen.resetView

不需要

支持

支持

不支持