搜索 Wiki

搜索 Wiki，用户通过关键词查询 Wiki，只能查找自己可见的 wiki

注： Wiki 存在，但用户搜索不到并不一定是搜索有问题，可能是用户没有查看该 Wiki 的权限

文档类型表

obj_type	说明
0	Folder
2	Doc
3	Sheet
8	Bitable
11	Mindnote
12	File
15	Slide
16	Wiki
22	Docx

错误码

HTTP 状态码	错误码	描述	排查建议
200	10001	invalid param	参数错误，参考文档检查输入参数
200	10002	network anomaly, please try again	后端服务异常或网络异常，可重新请求

curl --location --request POST 'https://open.feishu.cn/open-apis/wiki/v1/nodes/search' \ --header 'Authorization;' \ --header 'Content-Type: application/json' \ --data-raw '{ "query": "搜索关键词", "space_id": "xxxxxxx", "node_id": "xxxx" }'

{ "code": 0, "msg": "调用成功的描述信息", "data": { "items": [ { "node_id": "node_id-value", "space_id": "space_id-value", "parent_id": "parent_id-value", "obj_type": "obj_type-value", "title": "title-value", "url": "url-value", "icon": "icon-value" } ], "page_token": "page_token-value", "has_more": "has_more-value" } }

请求参数

Query 参数

page_token

string

可选

下一页的分页 token，首页不需要填写，根据返回的 token 获取下一页数据

page_size

integer

可选

本页返回数量的最大值 0 < page_size <= 50 默认 20

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

query

string

搜索关键词

必需

space_id

string

可选

文档所属的知识空间ID，为空搜索全部知识空间

node_id

string

可选

不为空搜索该节点及其所有子节点，为空搜索所有 wiki（使用 node_id 过滤必须传入 space_id）

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {7}]

wiki 信息数组

必需

page_token

string

必需

如果 has_more 为 true 则返回下一页的 token

has_more

string

是否还有下一页数据

必需

文档类型表#

错误码#

请求参数

返回响应

文档类型表

错误码