七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
知识库知识库外部开放接口

获取空间下所有文档

根据 spaceId 返回文档列表;keyword 为空时保持原列表行为。searchType=1/2 表示模糊/精确搜索,searchContent=1/2/3 表示全部内容/仅标题/仅正文。

请求体

名称类型必填描述示例值
spaceIdint64是知识库空间 ID。123456
keywordstring否可选标题关键词,最长 20 个字符。
searchTypeint32否搜索类型:1 模糊搜索,2 精确短语搜索。
searchContentint32否搜索内容:1 全部内容(标题或正文),2 仅标题,3 仅正文。

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject[]文档或目录列表。
└docIdint64文档 ID。987654
└spaceIdint64所属空间 ID。123456
└docNamestring文档或目录名称。退款规则
└parentIdint64父目录 ID;根目录通常为 0。0
└docTypestring文档类型。PDF
└creatorstring创建人账号或 GUID。zhangsan
└creatorNamestring创建人姓名。张三
└createTimeint64创建时间,毫秒时间戳。1781245600000
└editorstring最近编辑人账号或 GUID。lisi
└editorNamestring最近编辑人姓名。李四
└editTimeint64最近编辑时间,毫秒时间戳。1781249200000
└deleterstring删除人账号或 GUID,仅已删除数据返回。wangwu
└deleterNamestring删除人姓名,仅已删除数据返回。王五
└deleteTimeint64删除时间,毫秒时间戳,仅已删除数据返回。1781252800000
└deleteFlagboolean是否已删除。false

错误码

状态码描述
400请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。
401OPENAPI_AUTH 鉴权失败。常见业务码:405 AUTH_FAILED。
404资源不存在。常见业务码:404 NOT_FOUND、408 SPACE_NOT_EXISTS。
500服务内部异常。常见业务码:500 ERROR。
postEndpoint
/api/athena/openApi/external/getDocList
POST
/api/athena/openApi/external/getDocList
curl -X POST "https://b.163.com/api/athena/openApi/external/getDocList" \  -H "Content-Type: application/json" \  -d '{    "spaceId": 123456  }'
{
  "code": 200,
  "msg": "ok",
  "message": "string",
  "data": [
    {
      "docId": 987654,
      "spaceId": 123456,
      "docName": "退款规则",
      "parentId": 0,
      "docType": "PDF",
      "creator": "zhangsan",
      "creatorName": "张三",
      "createTime": 1781245600000,
      "editor": "lisi",
      "editorName": "李四",
      "editTime": 1781249200000,
      "deleter": "wangwu",
      "deleterName": "王五",
      "deleteTime": 1781252800000,
      "deleteFlag": false
    }
  ]
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}
{
  "code": 200,
  "msg": "ok",
  "message": "string"
}

这篇文档有帮助吗?