查询文件（夹）列表

说明

调用本接口查询文件（夹）列表。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉盘应用文件读权限	API Explorer
第三方企业应用	暂不支持	钉盘应用文件读权限	暂不支持
第三方个人应用	暂不支持	钉盘应用文件读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	param.error.maxresults	Too Large MaxResults	MaxResults过大
400	param.error	Invalid Param	参数错误
404	object.not.exist	File does not exist or has been deleted.	文件不存在或已删除
500	request.overlimit	You have sent too many requests.	请求过于频繁
500	unsupported.operation	Does not support the operation	暂不支持该操作
500	no.priviledge	You are not authorized to perform this operation.	你没有权限进行此操作
500	unknown.error	Unknown Error	未知错误

请求参数

Path 参数

spaceId

string

必需

钉盘空间ID，可调用获取空间列表接口获取。

Query 参数

unionId

string

必需

用户unionId，可以调用通过免登码获取用户信息(v2)接口获取。

parentId

string

可选

nextToken

string

分页游标。

可选

maxResults

string

分页大小。

必需

orderType

string

可选

排序类型，取值：默认值：createTimeDesc

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

files

array [object {13}]

文件列表。

可选

spaceId

string

钉盘空间ID。

可选

parentId

string

父目录ID。

可选

fileId

string

文件ID。

可选

fileName

string

文件名称。

可选

filePath

string

文件路径。

可选

fileType

string

文件类型。

可选

contentType

string

可选

文件内容类型，取值：

fileExtension

string

文件后缀名。

可选

fileSize

integer

文件大小。

可选

createTime

string

创建时间。

可选

modifyTime

string

修改时间。

可选

creator

string

创建者ID。

可选

modifier

string

修改者ID。

可选

nextToken

string

可选

下一页的游标，为空字符串则表示分页结束。

示例

{
  "files": [
    {
      "spaceId": "string",
      "parentId": "string",
      "fileId": "string",
      "fileName": "string",
      "filePath": "string",
      "fileType": "string",
      "contentType": "string",
      "fileExtension": "string",
      "fileSize": 0,
      "createTime": "string",
      "modifyTime": "string",
      "creator": "string",
      "modifier": "string"
    }
  ],
  "nextToken": "string"
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码