小程序API
基础能力
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
判断小程序的API、回调、参数、组件等是否在当前版本可用。 |
支持 |
支持 |
支持 |
|
获取基础库版本号。 |
支持 |
支持 |
支持 |
免登
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
判断小程序的API、回调、参数、组件等是否在当前版本可用。 |
支持 |
支持 |
支持 |
|
获取基础库版本号。 |
支持 |
支持 |
支持 |
更新管理小程序
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
获取全局唯一的版本更新管理器,用于管理小程序更新。 |
支持 |
支持 |
支持 |
|
强制小程序重启并使用新版本。 |
支持 |
支持 |
支持 |
|
监听向钉钉后台请求检查更新结果事件。 |
支持 |
支持 |
支持 |
|
监听小程序有版本更新事件。 |
支持 |
支持 |
支持 |
|
监听小程序更新失败事件。 |
支持 |
支持 |
支持 |
网络
类目 |
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
发网络请求 |
发送HTTP网络请求。 |
支持 |
支持 |
支持 |
|
上传下载 |
将本地资源上传到服务器。 |
支持 |
支持 |
支持 |
|
下载文件资源到本地。 |
支持 |
支持 |
支持 |
||
WebSocket |
创建WebSocket的连接。 |
支持 |
支持 |
支持 |
|
监听WebSocket连接打开事件。 |
支持 |
支持 |
支持 |
||
取消监听WebSocket连接打开事件。 |
支持 |
支持 |
支持 |
||
监听WebSocket错误。 |
支持 |
支持 |
支持 |
||
取消监听WebSocket错误。 |
支持 |
支持 |
支持 |
||
通过WebSocket连接发送数据。 |
支持 |
支持 |
支持 |
||
监听WebSocket接受到服务器的消息事件。 |
支持 |
支持 |
支持 |
||
取消监听WebSocket接受到服务器的消息事件。 |
支持 |
支持 |
支持 |
||
关闭WebSocket连接。 |
支持 |
支持 |
支持 |
||
监听WebSocket关闭。 |
支持 |
支持 |
支持 |
||
取消监听WebSocket关闭。 |
支持 |
支持 |
支持 |
多媒体
类目 |
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
图片 |
选择图片。 |
支持 |
支持 |
支持 |
|
预览图片。 |
支持 |
支持 |
支持 |
||
保存在线、本地临时或者永久地址图片到手机相册。 |
支持 |
支持 |
支持 |
||
压缩图片。 |
支持 |
支持 |
支持 |
||
获取图片信息。 |
支持 |
支持 |
支持 |
||
图片编辑 |
编辑图片(支持远程https图片地址和本地虚拟路径),提供涂鸦、裁剪、马赛克等功能。 |
支持 |
支持 |
支持 |
|
录音管理 |
获取当前小程序全局唯一的录音管理器 recordManager。 |
支持 |
支持 |
支持 |
|
背景音频管理 |
获取当前小程序全局唯一的背景音频管理 backgroundAudioManager。 |
支持 |
支持 |
支持 |
|
视频 |
选择视频。 |
支持 |
支持 |
支持 |
节点查询
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
创建并返回一个 |
支持 |
支持 |
支持 |
|
节点查询。 |
支持 |
支持 |
支持 |
界面
类目 |
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
导航栏 |
保留当前页面,跳转到应用内的某个指定页面,可以使用 |
支持 |
支持 |
支持 |
|
关闭当前页面,跳转到应用内的某个指定页面。 |
支持 |
支持 |
支持 |
||
关闭当前页面,返回上一级或多级页面。 |
支持 |
支持 |
支持 |
||
关闭当前所有页面,跳转到应用内的某个指定页面。 |
支持 |
支持 |
支持 |
||
设置导航栏文字及样式。 |
支持 |
支持 |
支持 |
||
TabBar |
跳转到指定 tabBar 页面,并关闭其他所有非 tabBar 页面。 |
支持 |
支持 |
支持 |
|
为 tabBar 某一项的右上角添加文本。 |
支持 |
支持 |
支持 |
||
移除 tabBar 某一项右上角的文本。 |
支持 |
支持 |
支持 |
||
显示 tabBar 某一项的右上角的红点。 |
支持 |
支持 |
支持 |
||
添加 tabBar页面。 |
支持 |
支持 |
支持 |
||
隐藏 tabBar 某一项的右上角的红点。 |
支持 |
支持 |
支持 |
||
交互反馈 |
alert 警告框。 |
支持 |
支持 |
支持 |
|
confirm 确认框。 |
支持 |
支持 |
支持 |
||
显示一个弱提示,可选择多少秒之后消失。 |
支持 |
支持 |
支持 |
||
显示加载提示。 |
支持 |
支持 |
支持 |
||
隐藏加载提示。 |
支持 |
支持 |
支持 |
||
显示操作菜单。 |
支持 |
支持 |
支持 |
||
离开页面二次确认 |
对当前页面进行离开二次确认配置。 |
支持 |
支持 |
支持 |
|
取消当前页面的离开二次确认配置。 |
支持 |
支持 |
支持 |
||
下拉刷新 |
下拉刷新。 |
支持 |
支持 |
支持 |
|
停止当前页面的下拉刷新。 |
支持 |
支持 |
支持 |
||
选择日期 |
选择日期。 |
支持 |
支持 |
支持 |
|
创建动画 |
创建动画。 |
支持 |
支持 |
支持 |
|
画布 |
画布。 |
支持 |
支持 |
支持 |
|
键盘 |
监听键盘弹起事件,并返回键盘高度。 |
支持 |
支持 |
支持 |
|
监听键盘收起事件。需要在page中设置该回调。 |
支持 |
支持 |
支持 |
||
隐藏键盘。 |
支持 |
支持 |
支持 |
||
滚动 |
滚动到页面的目标位置。 |
支持 |
支持 |
支持 |
位置
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
获取用户当前的地理位置信息。 |
支持 |
支持 |
支持 |
|
使用内置地图查看位置。 |
支持 |
支持 |
支持 |
缓存
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
将数据存储在本地缓存中指定的key中,会覆盖掉原来该key对应的数据。 |
支持 |
支持 |
支持 |
|
同步将数据存储在本地缓存中指定的 key 中。 |
支持 |
支持 |
支持 |
|
获取缓存数据。 |
支持 |
支持 |
支持 |
|
同步获取缓存数据。 |
支持 |
支持 |
支持 |
|
删除缓存数据。 |
支持 |
支持 |
支持 |
|
同步删除缓存数据。 |
支持 |
支持 |
支持、 |
地图
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
地图组件。 |
支持 |
支持 |
支持 |
设备
类目 |
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
系统信息 |
获取系统信息。 |
支持 |
支持 |
支持 |
|
获取系统信息,返回值同 getSystemInfo success 回调参数。 |
支持 |
支持 |
支持 |
||
网络状态 |
获取网络状态。 |
支持 |
支持 |
支持 |
|
剪切板 |
获取剪切板数据。 |
支持 |
支持 |
支持 |
|
设置剪切板数据。 |
支持 |
支持 |
支持 |
||
震动 |
调用震动功能。 |
支持 |
支持 |
支持 |
|
使用短振动功能。 |
支持 |
支持 |
支持 |
||
使用长振动功能。 |
支持 |
支持 |
支持 |
||
蓝牙 |
初始化蓝牙接口。 |
支持 |
支持 |
支持 |
|
蓝牙适配器状态监听。 |
支持 |
支持 |
支持 |
||
蓝牙发现事件监听。 |
支持 |
支持 |
支持 |
||
蓝牙连接状态事件监听。 |
支持 |
支持 |
支持 |
||
搜索设备。 |
支持 |
支持 |
支持 |
||
查找设备并连接。 |
支持 |
支持 |
支持 |
||
停止搜索设备。 |
支持 |
支持 |
支持 |
||
获取服务。 |
支持 |
支持 |
支持 |
||
获取特征。 |
支持 |
支持 |
支持 |
||
监听特征值变化事件通知。 |
支持 |
支持 |
支持 |
||
设置读特征通知模式。 |
支持 |
支持 |
支持 |
||
向设备的特征值写数据。 |
支持 |
支持 |
支持 |
||
向设备的特征值读数据。 |
支持 |
支持 |
支持 |
||
断开连接。 |
支持 |
支持 |
支持 |
||
关闭蓝牙适配器。 |
支持 |
支持 |
支持 |
扫码
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
调用扫一扫功能。 |
支持 |
支持 |
支持 |
分享
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
分享。 |
支持 |
支持 |
支持 |
通讯录选人
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
选人与部门。选择部门后把该部门转换成对应部门下的人。 |
支持 |
支持 |
不支持 |
|
选择部门信息。调用该接口会返回部门的信息,是以部门为纬度,不是以人为纬度。 |
支持 |
支持 |
不支持 |
|
创建群聊天。 |
支持 |
支持 |
不支持 |
|
选择手机通讯录。 |
支持 |
支持 |
不支持 |
|
选择外部联系人。 |
支持 |
支持 |
不支持 |
|
编辑外部联系人。 |
支持 |
支持 |
不支持 |
|
选取单个自定义联系人。 |
支持 |
支持 |
不支持 |
Ding
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
发钉接口支持唤起DING、任务、日程等创建界面。 |
支持 |
支持 |
不支持 |
电话
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
拨打钉钉电话。 |
支持 |
支持 |
不支持 |
|
唤起拨打电话菜单。 |
支持 |
支持 |
支持 |
|
检查某企业办公电话开通状态。 |
支持 |
支持 |
不支持 |
支付
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
支付。 |
支持 |
支持 |
支持 |
钉盘
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
转存文件到钉盘。 |
支持 |
支持 |
不支持 |
|
钉盘文件预览。 |
支持 |
支持 |
不支持 |
|
上传附件到钉盘/从钉盘选择文件。 |
支持 |
支持 |
不支持 |
|
选取钉盘目录。 |
支持 |
支持 |
不支持 |
会话
API名称 |
API说明 |
企业内部应用 |
第三方企业应用 |
第三方个人应用 |
获取会话信息。 |
支持 |
支持 |
不支持 |
|
选择会话。 |
支持 |
支持 |
不支持 |
|
根据chatId跳转到对应会话。 |
支持 |
支持 |
不支持 |
|
打开与某个用户的聊天页面(单聊会话)。 |
支持 |
支持 |
不支持 |