概述 - 钉钉 API

本文档主要介绍什么是云盘，云盘接口能力，以及如何接入云盘接口能力等。

重要

为便于开发者接入，钉盘产品名称将于2022年2月14日更新为云盘，与钉钉产品名称保持一致。

什么是云盘（钉盘）

钉钉云盘（钉盘）是基于阿里云的企业盘，提供智能安全的企业数据管理方案。云盘是集文件存储、管理与多人协作于一体的文件管理平台。它支持在任何设备上随时随地一键存储、编辑、分享工作学习资料，文档协作更高效。

钉钉云盘由私人盘和企业盘组成，其中企业盘由三个文件夹组成：

我的文件、团队文件。

群文件。

其他微应用存储，可在OA后台“云盘-容量管理-微应用”查看。

私人盘初始容量为2GB，企业盘初始容量为100GB。更多功能介绍，请参见钉钉使用手册-云盘。

云盘接口能力

云盘开放的接口列表

云盘提供了丰富的接口开放能力，开发者通过API接口可以实现云盘和企业业务系统打通。

文件传输

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取文件上传信息	获取文件上传信息。	获取文件上传信息	-
获取文件下载信息	获取文件下载信息。	获取文件下载信息	-
单步文件上传	上传文件到钉盘。	-	单步文件上传
开启分块上传事务	上传文件到钉盘。	-	开启分块上传事务
上传文件块	上传文件到钉盘。	-	上传文件块
提交文件上传事务	上传文件到钉盘。	-	提交文件上传事务
发送钉盘文件给指定用户	将文件发送给指定用户，用户将收到以应用名义发送的一条文件消息。	-	发送钉盘文件给指定用户

空间管理

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
新建空间	新建企业共享空间。	新建空间	-
删除空间	删除企业共享空间。	删除空间	-
获取空间列表	查询钉盘空间列表。	获取空间列表	-
保存文件到自定义或审批钉盘空间	将文件保存到自定义钉盘空间或审批附件钉盘空间。	-	保存文件到自定义或审批钉盘空间
获取空间信息	获取空间详情信息。	获取空间信息	获取应用自定义空间使用详情（历史版本）
添加自定义空间权限	授权企业下指定人员访问其使用的自定义空间。	添加自定义空间权限	授权用户访问企业的自定义空间（历史版本）
获取企业下的自定义空间	获取企业下的自定义空间。	-	获取企业下的自定义空间

文件管理

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
查询文件（夹）列表	查询文件（夹）列表。	查询文件（夹）列表	-
查询文件（夹）信息	查询文件（夹）信息。	查询文件（夹）信息	-
添加文件（夹）	添加文件（夹）。	添加文件（夹）	-
删除文件（夹）	删除文件（夹）。	删除文件（夹）	-
移动文件（夹）	移动文件（夹）。	移动文件（夹）	-
修改文件（夹）名	修改文件（夹）名称。	修改文件（夹）名	-
拷贝文件（夹）	拷贝文件（夹）。	拷贝文件（夹）	-

回收站

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
查询回收站文件（夹）列表	查询回收站内文件（夹）列表。	查询回收站文件（夹）列表	-
还原回收站文件（夹）	还原回收站中的文件或文件夹。	还原回收站文件（夹）	-
删除回收站文件（夹）	删除回收站文件或文件夹。	删除回收站文件（夹）	-
清空回收站	清空回收站。	清空回收站	-

权限管理

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取权限列表	获取用户对钉盘空间和文件的权限列表。	获取权限列表	-
添加权限	添加用户对钉盘空间和文件的权限。	添加权限	-
删除权限	删除用户对钉盘空间和文件的权限。	删除权限	-
修改权限	修改用户对钉盘空间和文件的权限。	修改权限	-

如何接入云盘接口能力

钉钉提供了云盘接口接入流程示例。

钉盘共享空间上传及下载钉盘文件

钉盘共享空间上传及删除钉盘文件

云盘基础概念

术语	说明
spaceId	钉盘以space作为文件存储容器，可类比电脑上的C盘、E盘等。例如在钉钉内，每一个群文件对应一个space，企业钉盘中的公共区、共享文件夹、我的文件等也分别对应一个space。
fileId	文件在钉盘内的唯一性标识。
自定义空间	针对企业或ISV的个性化需求，钉盘在企业下开辟了自定义空间来供企业或ISV使用。每个企业可以自定义若干存储空间，每个微应用可以使用一个自定义存储空间，该空间在钉钉客户端不可见，在电脑管理后台可以查看其占用企业空间的情况。
钉盘权限	区别于普通文件存储，钉盘提供完善的权限管理服务，文件的上传、下载、查看等操作需要在权限允许的条件下执行。
存储服务器 & 钉盘服务器	存储服务器提供文件的存储服务，存储服务器上以mediaId唯一标识文件。钉盘服务器提供文件的目录关系、权限管理等服务。钉盘系统以fileId唯一标识文件，存储服务器内文件可添加到钉盘文件系统。
企业空间容量	钉盘存储空间属于有限资源，超出部分需付费购买。钉盘为企业免费提供100G空间，微应用使用的自定义空间将占用企业空间。

资源

空间资源包含以下属性：

属性	类型	说明
spaceId	string	空间ID。
spaceName	string	空间名称。
spaceType	string	空间类型。personal：私人空间org：企业空间
quota	int64	空间总容量。说明-1表示该空间额度无限制，如果有企业属性，不能超过企业空间额度。
usedQuota	int64	空间已使用容量。
createTime	string (iso8601)	创建时间。
modifyTime	string (iso8601)	修改时间。

文件和文件夹资源包含以下属性：

属性	类型	类型
spaceId	string	空间ID。
fileId	string	文件ID。
fileName	string	文件名称。
filePath	string	文件路径。
fileType	string	文件类型。file：文件folder：文件夹
fileExtension	string	文件后缀名。

文件下载包含以下属性：

属性	类型	类型
resourceUrl	string	下载地址。
expirationSeconds	int64	下载地址有效时间，单位：秒。
headers	map	下载所需的headers，包含一些鉴权信息。

文件上传包含以下属性：

属性	类型	说明
bucket	string	OSS存储空间。
endPoint	string	OSS访问域名。
accessKeyId	string	阿里云账号的临时accessKeyId。
accessKeySecret	string	阿里云账号的临时accessKeySecret。
accessToken	string	临时访问密钥。
accessTokenExpirationMillis	int64	密钥过期时间，毫秒。
mediaId	string	对应OSS ObjectKey，可用于刷新token，调用添加文件（夹）接口添加文件时，需填写此参数。

回收站Item包含以下属性：

属性	类型	说明
recycleItemId	string	回收站记录ID。
deleteTime	string (iso8601)	删除时间。
fileSize	int64	文件大小。
fileType	string	文件类型。file：文件folder：文件夹
fileName	string	文件名称。
filePath	string	文件路径。

权限包含以下属性：

属性	类型	说明
role	string	权限角色。owner：所有者admin：管理员editor：可编辑viewer：可查看/下载only_viewer：只读
corpId	string	企业的corpId。
memberType	string	成员类型。org：企业department：部门conversation：群user：用户
memberId	String	成员ID。当memberType为org时，取值为corpId。当memberType为department时，取值为deptId。当memberType为conversation时，取值为chatId。当memberType为user时，取值为staffId。
memberName	string	成员名称。
extend	boolean	是否是继承的权限。

如何使用云盘API

添加接口调用权限。

登录开发者后台，单击进入应用详情页。

单击权限管理，最后选择钉盘对应的接口权限，单击申请权限。

通过以下方式获取鉴权凭证access_token。

企业内部应用，通过获取企业内部应用的access_token接口。

第三方企业应用，通过获取第三方企业应用的access_token接口。

通过以下方式获取unionId等用户信息。

**企业内部应用，**调用通过免登码获取用户信息接口。

**第三方企业应用，**调用通过免登码获取用户信息接口。

调用钉盘API接口。

概述

什么是云盘（钉盘）#

云盘接口能力#

云盘开放的接口列表#

如何接入云盘接口能力#

云盘基础概念#

资源#