文档搜素

该接口用于根据搜索条件进行文档搜索。

错误码

curl --location --request POST 'https://open.feishu.cn/open-apis/suite/docs-api/search/object' \ --header 'Authorization;' \ --header 'Content-Type: application/json' \ --data-raw '{ "search_key": "search key", "count": 10, "offset": 0, "owner_ids": ["xxx", "xxx"], "chat_ids": ["xxx", "xxx"], "docs_types": ["doc", "sheet"] }'

{ "code": 0, "msg": "Success", "data": { "docs_entities": [ { "docs_token": "xxx", "docs_type": "doc", "title": "xxx", "owner_id": "xxx" }, { "docs_token": "xxx", "docs_type": "sheet", "title": "xxx", "owner_id": "xxx" } ], "has_more": false, "total": 10 } }

请求参数

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

search_key

string

搜索关键字

必需

count

integer

可选

搜索返回数量，0 <= count <= 50

offset

integer

可选

搜索偏移位，offset >= 0，offset + count < 200

owner_ids

array[string]

可选

文档所有者的userid

chat_ids

array[string]

可选

文档所在群的chatid

docs_types

array[string]

可选

文档类型，支持："doc", "sheet", "slide", "bitable", "mindnote", "file"

示例

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

docs_entities

array [object {4}]

搜索匹配文档列表

必需

has_more

boolean

必需

搜索偏移位结果列表后是否还有数据

total

integer

搜索匹配文档总数量

必需

错误码#

请求参数

返回响应

错误码