什么是存储
存储API提供智能安全的企业数据管理方案，可以满足围绕文件存储的办公场景协作所需，主要能力包括但并不限于文件的上传、下载、管理、流转，主流文件在线预览和编辑能力，权限管理等。可以使用存储API实现从简单的应用附件到复杂的云盘类产品的功能需要。 当你的应用使用存储API后，可以实现：- 可以和钉钉其他应用中的文件高效流转。
- 可以满足企业管理员的文件管控需要，详情请参见钉钉管理后台。
开放概览
存储提供了丰富的接口开放能力，开发者通过API接口可以实现存储和企业业务系统打通。企业管理
| API | API说明 | API版本 |
|---|---|---|
| 获取企业信息 | 获取企业存储的相关信息。 | 新版 |
应用
| API版本 | API版本 | API版本 |
|---|---|---|
| 获取群存储空间信息 | 获取群存储空间信息。 | 新版 |
| 以应用身份发送文件给指定用户 | 以应用身份发送文件给指定用户。 | 新版 |
| 发送文件到指定会话 | 发送文件到指定会话。 | 新版 |
| 发送文件链接到指定会话 | 发送文件链接到指定会话。 | 新版 |
| 获取应用信息 | 获取应用信息。 | 新版 |
空间管理
文件管理
| API版本 | API版本 | API版本 |
|---|---|---|
| 添加文件夹 | 在存储空间内添加文件夹。 | 新版 |
| 复制文件或文件夹 | 复制文件或文件夹。 | 新版 |
| 批量复制文件或文件夹 | 批量复制文件或文件夹。 | 新版 |
| 移动文件或文件夹 | 移动文件或文件夹的位置。 | 新版 |
| 批量移动文件或文件夹 | 批量移动文件或文件夹。 | 新版 |
| 重命名文件或文件夹 | 重命名文件或文件夹。 | 新版 |
| 删除文件或文件夹 | 删除文件或文件夹。 | 新版 |
| 批量删除文件或文件夹 | 批量删除文件或文件夹。 | 新版 |
| 恢复文件历史版本 | 恢复文件历史版本。 | 新版 |
| 获取文件版本列表 | 获取文件版本列表。 | 新版 |
| 获取文件或文件夹信息 | 获取文件或文件夹信息。 | 新版 |
| 批量获取文件或文件夹信息 | 批量获取文件或文件夹信息。 | 新版 |
| 获取文件或文件夹列表 | 获取空间内的文件或文件夹列表。 | 新版 |
| 获取空间下所有文件或文件夹列表 | 平铺获取空间下所有文件或文件夹列表。 | 新版 |
| 获取文件预览或编辑信息 | 获取文件预览或编辑的链接。 | 新版 |
| 更新文件或文件夹的应用属性 | 更新文件或文件夹的应用属性。 | 新版 |
| 删除文件或文件夹的应用属性 | 删除文件或文件夹的应用属性。 | 新版 |
| 批量获取文件缩略图 | 批量获取文件的缩略图信息。 | 新版 |
文件传输
| API版本 | API版本 | API版本 |
|---|---|---|
| 获取文件上传信息 | 获取文件上传信息。 | 新版 |
| 提交文件 | 提交文件完成文件上传。 | 新版 |
| 初始化文件分片上传 | 初始化文件分片上传。 | 新版 |
| 获取文件分片上传信息 | 获取文件分片后每片文件的上传信息。 | 新版 |
| 获取文件下载信息 | 获取存储空间内文件的下载信息。 | 新版 |
权限管理
回收站管理
任务管理
| API版本 | API版本 | API版本 |
|---|---|---|
| 获取存储中异步任务信息 | 获取存储中异步任务信息。 | 新版 |
事件订阅
| API版本 | API版本 | API版本 |
|---|---|---|
| 订阅文件变更事件 | 订阅存储文件变更事件。 | 新版 |
| 取消订阅文件变更事件 | 取消订阅存储文件变更事件。 | 新版 |
使用教程
钉钉提供了存储接口接入流程示例。| 教程名称 | 功能介绍 | 教学范围 | Demo 下载 |
|---|---|---|---|
| 钉盘文件的上传、预览和下载 | 钉盘文件的上传、下载、预览 | 所有钉钉开发者 | file-demo.zip |
| 上传本地文件到钉钉文档（我的文档） | 将本地文件上传到钉钉文档（我的文档）目录下 | 所有钉钉开发者 | doc-demo.zip |
资源说明
-
空间资源主要包含以下属性：
属性 类型 说明 spaceId string 空间Id。 spaceName string 空间名称。 spaceType string 空间类型。 - USER：用户空间 - APP：应用空间 quota int64 空间总容量。 说明 -1表示该空间额度无限制，如果有企业属性，不能超过企业空间额度。 usedQuota int64 空间已使用容量。 createTime string (iso8601) 创建时间。 modifyTime string (iso8601) 修改时间。 -
文件和文件夹资源主要包含以下属性：
属性 类型 类型 id string 文件或文件夹的id。 spaceId string 空间Id。 path string 文件或文件夹在空间内的路径。 status string 状态。 - NORMAL：正常 - DELETED：已删除 - EXPIRED：已过期 partitionType string 存储分区。 - PUBLIC_OSS_PARTITION：公有云OSS存储分区 - MINI_OSS_PARTITION：专属MiniOSS存储分区 parentId string 文件目录Id。 fileType string 文件类型。 - FILE：文件 - FOLDER：文件夹 extension string 文件后缀名。 -
权限主要包含以下属性：
属性 类型 说明 id string 权限成员id。 - 如果type参数值为ORG，该参数值传企业corpId。 - 如果type参数值为DEPT，该参数值传部门deptId，调用获取部门列表接口获取dept_id参数值。 - 如果type参数值为TAG，该参数值传tag名称。 - 如果type参数值为CONVERSATION，该参数值传会话openConversationId，通过创建群会话接口或创建场景群接口获取。 - 如果type参数值为USER，该参数传用户unionId，可调用查询用户详情接口获取unionid参数值。 roleId string 权限角色Id。 - OWNER：拥有者 - MANAGER：管理者 - EDITOR：编辑者 - DOWNLOADER：下载者 - READER：查看者 type string 权限成员类型： - ORG：企业 - DEPT：部门 - TAG：自定义tag - CONVERSATION：会话 - USER：用户 duration string 授权有效时长，单位秒，默认值为-1，表示永久有效。 - 被添加权限的空间类型是APP时，授权有效时长生效。 - 被添加权限的空间类型是USER时，授权有效时长无效，默认为永久有效。