搜索文件

接口说明

搜索和关键字匹配的文件，需要指定关键字类型

请求格式

描述	定义
Path	/openapi/drive/v3/files:search
Method	POST
Content-Type	application/json; charset=utf-8

请求头部

详见Headers。

请求参数

请求体

参数名	类型	必选	描述
keyword	string	是	文件 Id，文件的唯一标识
field	enum(Field)	是	用于指定搜索的字段类型
offset	integer	是	搜索文件的起点
limit	integer	是	单次搜索的最大文件数量
directoryFileId	string	否	指定文位置搜索，不传入则搜根路径
extension	array(enum(FileExt))	否	指定文档类型搜索，不传入则搜全部文档类型
range	object(Range)	否	指定时间范围搜索，不传则不会根据时间来过滤结果
source	array(enum(FileSource))	否	指定来源搜索，不传默认搜索全部来源的
isSpace	bool	否	为true只查询共享空间下的文件 不传则会查询所有列表的文件

关键字类型 Field

字段	描述
FILE_NAME	文件名
OWNER_NAME	拥有者名字
CONTENT	文档内容

关键字类型 FileExt

字段	描述
ALL	全部文件类型，不传的默认值
DOC	文档
SHEET	表格
PPT	幻灯片
FORM	收集表
PDF	PDF
SMART_CANVAS	智能文档
SMART_SHEET	智能表格
MIND	思维导图
FLOWCHART	流程图

关键字类型 Range

字段	类型	描述
begin	uint64	文件最后访问时间-开始时间，毫秒级时间戳
end	uint64	文件最后访问时间-结束时间，毫秒级时间戳

关键字类型 FileSource

字段	描述
ALLFILES	全部文件，缺省的默认值
MY	我所有的文件
OTHERS	他人所有的文件

请求示例

curl --location 'https://{domain}/openapi/drive/v3/files:search' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--data '{
    "keyword":"测试",
    "field":"FILE_NAME",
    "offset": 0,
    "limit": 15,
    "directoryFileId":"AkUWkJQZLkGJXlmToE",
    "range":{
        "begin":1704441003799,
        "end":1722848027516
    },
    "source":"ALLFILES"
}'

响应参数

响应体

参数名	类型	描述
files[]	object(FileData)	关键字匹配的多个文件信息
next	integer	下一次搜索的起点
total	string	符合条件的文件总数

返回结果 FileData

参数名	类型	描述
file	object(FileInfo)	关键字匹配的文件信息
highLight	string	关键字搜索高亮匹配文字，以<em>，</em>成对出现标识高亮
pathName	string	文件的路径名称，从根目录/开始的路径名称

响应包体

{
    "files": [
        {
            "file": {
                "meta": {
                    "id": "DQWNlQXJXTFd3QlNLam1XcFpF",
                    "parentId": "AMQPxytMJoBysCEFSE",
                    "name": "测试文档",
                    "type": "DOC",
                    "ext": "tencentdoc",
                    "url": "https://{domain}/doc/DQWNlQXJXTFd3QlNLam1XcFpF",
                    "icon": "https://{domain}/private_cdn/tim/docs/docs-design-resources/mobile/png@3x/file_doc_64@3x-58ec57f56b.png",
                    "creator": {
                        "id": "1127086903250649088"
                    },
                    "createTime": "1722847726507",
                    "owner": {
                        "id": "1127086903250649088"
                    },
                    "lastModifyingUser": {
                        "id": "1127086903250649088"
                    },
                    "modifiedTime": "1722847734681",
                    "accessTime": "1722847733578",
                    "isFolder": false,
                    "isLink": false
                },
                "entry": {
                    "isStar": false
                }
            },
            "highLight": "<em>测</em><em>试</em>文档",
            "pathName": "/aaa/bbb/bbb测试文档"
        },
        {
            "file": {
                "meta": {
                    "id": "DQVJZRlFuUG9OcWVuQXFaTVJD",
                    "parentId": "AkUWkJQZLkGJXlmToE",
                    "name": "测试.pdf",
                    "type": "PDF",
                    "ext": "pdf",
                    "url": "https://{domain}/pdf/DQVJZRlFuUG9OcWVuQXFaTVJD",
                    "icon": "https://{domain}/private_cdn/tim/docs/docs-design-resources/pc/png@3x/file_web_pdf_64@3x-0b5f822212.png",
                    "creator": {
                        "id": "1127086903250649088"
                    },
                    "createTime": "1722847235812",
                    "owner": {
                        "id": "1127086903250649088"
                    },
                    "lastModifyingUser": {
                        "id": "1127086903250649088"
                    },
                    "modifiedTime": "1722847247092",
                    "accessTime": "1722847235819",
                    "isFolder": false,
                    "isLink": false
                },
                "entry": {
                    "isStar": false
                }
            },
            "highLight": "<em>测</em><em>试</em>.pdf",
            "pathName": "/aaa/测试"
        }
    ],
    "next": 2,
    "total": "11"
}

错误码

查询通用错误码