搜索文件

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

搜索文件。

接口功能介绍

调用本接口，根据操作者unionId和关键词信息，获取文件信息。示例如下：

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	paramError	%s	参数错误
400	paramError-keyword	%s	参数错误-keyword
400	paramError.maxResults	%s	参数错误-maxResults
400	paramError.searchScopes	%s	参数错误-searchScopes
400	paramError.searchTargets	%s	参数错误-searchTargets
400	paramError.dentryTypes	%s	参数错误-dentryTypes
400	paramError.dentryCategories	%s	参数错误-dentryCategories
400	paramError.createTimeRange	%s	参数错误-createTimeRange
400	paramError.modifiedTimeRange	%s	参数错误-modifiedTimeRange
400	paramError.visitTimeRange	%s	参数错误-visitTimeRange
403	spaceNotAccessible	%s	空间不可访问
403	workspaceNotAccessible	%s	知识库不可访问
403	workspaceTeamNotAccessible	%s	知识小组不可访问
500	systemError	%s	服务繁忙，请稍后重试
500	unknownError	Unknown Error	未知错误
503	operationTimeout	%s	请求超时

curl --location --request POST 'https://api.dingtalk.com/v2.0/storage/dentries/search?operatorId=String' \ --header 'x-acs-dingtalk-access-token;' \ --header 'Content-Type: application/json' \ --data-raw '{ "keyword" : "String", "option" : { "nextToken" : "String", "maxResults" : Integer, "dentryCategories" : [ "String" ], "creatorIds" : [ "String" ], "modifierIds" : [ "String" ], "createTimeRange" : { "startTime" : Long, "endTime" : Long }, "visitTimeRange" : { "startTime" : Long, "endTime" : Long } } }'

{ "items": [ { "dentryUuid": "string", "name": "string", "creator": { "userId": "string", "name": "string" }, "modifier": { "userId": "string", "name": "string" } } ], "nextToken": "string" }

请求参数

Query 参数

operatorId

string

必需

操作人unionId。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

keyword

string

搜索关键词。

必需

option

object

可选参数。

可选

nextToken

string

可选

分页游标。说明首次拉取不用传。

dentryCategories

array[string]

限定文件类别。

可选

creatorIds

array[string]

限定创建者。

可选

modifierIds

array[string]

限定修改者。

可选

createTimeRange

object

可选

限定创建时间范围。说明不指定时, 默认所有创建时间。

visitTimeRange

object

可选

限定访问时间范围。说明不指定时, 默认所有访问时间。

示例

返回响应

🟢200成功

application/json

Body

items

array [object {4}]

必需

搜索结果列表，最大size50。

dentryUuid

string

文件uuid。

可选

name

string

文件名称。

可选

creator

object

创建者。

可选

modifier

object

修改者

可选

nextToken

string

必需

分页游标不为空表示有更多数据

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码