# 搜索文件

  • 搜索用户有权限的直书文件

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/zhishu/resource/search
HTTP METHOD POST
支持的应用 类型 自建应用
权限要求
开启任一权限即可
直书搜索

# 请求头

名称 类型 必填 描述
Authorization string user_access_token
值格式:"Bearer access_token"
示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 请求体

名称 类型 必填 描述
keyword string 指定搜索的关键词
pageSize int 指定搜索返回的文件数量。取值范围为 [0,50]。
pageNum int 指定搜索返回的文件页码。默认为 1。
fileType array 指定搜索的文件类型。默认为 0,表示全部文件类型。
0:全部文件类型
1:文档文件
2:表格
3:幻灯片
4:图片
5:视频
6:音频
7:脚本
8:文件夹
9:除上述以外的类型
10:所有文件
limitAllLibraries boolean 是否仅查询知识库下文件,默认为false

# 请求示例

{
    "keyword": "许8",
    "pageNum": 1,
    "pageSize": 50,
    "limitAllLibraries": true,
    "fileType": 1
}
1
2
3
4
5
6
7

# 响应

# 响应体

名称 类型 描述
code int 错误码,非 0 表示失败
message string 错误描述
zpData data
--total int 文件总数
--searchResourceList array 文件列表
----visitCode string 文件visitCode
----name string 文件名称
----type String 文件的类型
docs 则为轻文档
sheet 则为轻表格
bs 则为毕升文件
file 则为云文件
----createOpenId string 文件创建者openId
----createTime long 文件创建时间,单位为ms
----latestModifyTime long 文件最后更新时间,单位为ms
----url string 访问url
----securityLevel string 安全等级

# 响应示例

{
  "code": 0,
  "zpData": {
    "searchResourceList": [
      {
        "visitCode": "J4C5IFgGbRN",
        "type": "docs",
        "name": "许8",
        "createOpenId": "ou_83923b277cac8a4b4499f68ecee1147a",
        "createTime": 1683702625000,
        "latestModifyTime": 1703742176000,
        "url": "https://zhishu-qa.weizhipin.com/wiki/J4C5IFgGbRN",
        "securityLevel": "S2"
      }
    ],
    "total": 1
  },
  "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
最后更新于 : 10/28/2024, 5:38:25 PM