Overview

This topic describes what storage is, the capabilities of the Storage APIs, and the related resources.

​

What is storage

The Storage APIs provide an intelligent and secure data management solution for organizations and meet the needs of office collaboration scenarios centered around file storage. Core capabilities include but are not limited to file upload, download, management, and transfer, online preview and editing of mainstream file formats, and permission management. You can use the Storage APIs to build everything from simple app attachments to fully featured cloud drive products. After your app integrates the Storage APIs, you can:

• Transfer files efficiently between your app and other DingTalk apps.
• Meet the file governance needs of Organization Admins. For more information, see DingTalk admin console.

​

Open capability overview

Storage exposes a rich set of open API capabilities. Developers can integrate storage with their organization’s business systems through API calls.

​

Organization management

​

App

​

Space management

​

File management

​

File transfer

​

Permission management

​

Recycle Bin management

​

Task management

​

Event subscription

​

Tutorials

DingTalk provides integration flow examples for the Storage APIs.

​

Resource reference

• The Space resource includes the following attributes:

  Attribute	Type	Description
  spaceId	string	The space ID.
  spaceName	string	The space name.
  spaceType	string	The space type. - USER: user space - APP: app space
  quota	int64	The total capacity of the space. Note A value of -1 indicates that the space has no quota limit. If the space has an organization attribute, the quota cannot exceed the organization’s space quota.
  usedQuota	int64	The used capacity of the space.
  createTime	string (iso8601)	The created time.
  modifyTime	string (iso8601)	The modified time.

• The File and folder resource includes the following attributes:

  Attribute	Type	Description
  id	string	The ID of the file or folder.
  spaceId	string	The space ID.
  path	string	The path of the file or folder within the space.
  status	string	The status. - NORMAL: normal - DELETED: deleted - EXPIRED: expired
  partitionType	string	The storage partition. - PUBLIC_OSS_PARTITION: public cloud OSS storage partition - MINI_OSS_PARTITION: dedicated MiniOSS storage partition
  parentId	string	The parent folder ID.
  fileType	string	The file type. - FILE: file - FOLDER: folder
  extension	string	The file name extension.

• The Permission resource includes the following attributes:

  Attribute	Type	Description
  id	string	The ID of the permission user. - If the type parameter is ORG, set this parameter to the organization’s corpId. - If the type parameter is DEPT, set this parameter to the deptId of the department. Call the Obtain the department list API to obtain the dept_id value. - If the type parameter is TAG, set this parameter to the tag name. - If the type parameter is CONVERSATION, set this parameter to the openConversationId of the chat, which is obtained through the create group chat API or the create scenario group API. - If the type parameter is USER, set this parameter to the user’s unionId. Call the Query user details API to obtain the unionid value.
  roleId	string	The permission role ID. - OWNER: owner - MANAGER: manager - EDITOR: editor - DOWNLOADER: downloader - READER: viewer
  type	string	The permission user type: - ORG: organization - DEPT: department - TAG: custom tag - CONVERSATION: chat - USER: user
  duration	string	The authorization validity period, in seconds. The default value is -1, which indicates permanent validity. - The authorization validity period takes effect when the space type of the granted permission is APP. - The authorization validity period does not take effect when the space type of the granted permission is USER, and defaults to permanent validity.