Skip to content

搜索 Wiki

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

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

请求

基本
HTTP URLhttps://open.feishu.cn/open-apis/wiki/v2/nodes/search
HTTP MethodPOST
HTTP Content-Typeapplication/json; charset=utf-8
凭证要求user_access_token
权限要求查看知识库

查询参数

属性名称类型必填描述
page_tokenstring下一页的分页 token,首页不需要填写,根据返回的 token 获取下一页数据
page_sizeint本页返回数量的最大值 0 < page_size <= 50 默认 20

请求体

属性名称类型必填描述
querystring搜索关键词,长度不超过50个字符
space_idstring文档所属的知识空间ID,为空搜索全部知识空间
node_idstring不为空搜索该节点及其所有子节点,为空搜索所有 wiki(使用 node_id 过滤必须传入 space_id)

请求体示例

json
{
    "query": "搜索关键词",
    "space_id": "xxxxxxx",
    "node_id": "xxxx"
}

响应

响应体

NameTypeDescription
codeint错误码,非 0 表示失败
msgstring错误描述
data--
  ∟itemslistwiki 信息数组
    ∟node_idstringwiki 节点的 token
    ∟space_idstringwiki 所属知识空间 Id
    ∟obj_typeintwiki 类型, 参考文档类型表
    ∟obj_tokenstring节点的真实文档的 token,如果要获取或编辑节点内容,需要使用此 token 调用对应的接口
    ∟parent_idstring暂未生效,一律返回空
    ∟sort_idint该知识库文档的序号,从 1 开始计数
    ∟titlestringwiki 标题
    ∟urlstringwiki 的访问 url
    ∟iconstringwiki 对应图标的 url
  ∟page_tokenstring如果 has_more 为 true 则返回下一页的 token
  ∟has_morebool是否还有下一页数据

文档类型表

obj_type说明
1Doc
2Sheet
3Bitable
4Mindnote
5File
6Slide(已废弃)
7Wiki
8Docx
9Folder
10Catalog
11Slides

响应体示例

json
{
  "code": 0,
  "data": {
    "has_more": false,
    "items": [
      {
        "node_id": "BAgPwq6lIi5Nykk0E5fcJeabcef",
        "obj_token": "AcnMdexrlokOShxe40Fc0Oabcef",
        "obj_type": 8,
        "parent_id": "",
        "sort_id": 1,
        "space_id": "7307457194084925443",
        "title": "欢迎使用知识库 / Welcome to Wiki",
        "url": "https://sample.feishu.cn/wiki/BAgPwq6lIi5Nykk0E5fcJeabcef"
      }
    ]
  },
  "msg": "success"
}

错误码

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

内容来源:飞书开放平台 · 自动爬取整理