开发文档
能力中心
应用市场
WebOffice
开发者后台

文件搜索 ​

文件搜索

请求说明 ​

请求地址https://openapi.wps.cn/v7/files/search
请求方法GET
签名方式KSO-1
权限要求搜索文件（用户授权） kso.file_search.readwrite

请求头（Header） ​

Header 名称参数类型是否必填说明
Content-Typestring是使用：application/json
X-Kso-Datestring是RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorizationstring是KSO-1 签名值，详见《签名方法》
Authorizationstring是授权凭证，格式为：Bearer {access_token}

查询参数（Query） ​

名称参数类型是否必填说明
channelsarray[string]否渠道信息
creator_idsarray[string]否创建者 id，公网只支持选择是否自己创建的文件
device_idsarray[string]否设备 id
drive_idsarray[string]否搜索盘列表，v7 接口支持数组，但是还没有应用场景
end_timeinteger否最大时间
exclude_channelsarray[string]否排除渠道信息
exclude_file_extsarray[string]否排除文件后缀
file_ext_groupsarray[string]否文件分组后缀
file_extsarray[string]否文件后缀
file_typestring[enum]否文件类型，不传默认全搜
folder：文件夹；file：文件；shortcut：快捷方式
filter_user_idinteger否创建者分享者过滤
keywordstring是搜索关键字
orderstring[enum]否排序方式
desc；asc
order_bystring[enum]否排序字段
ctime；mtime
page_sizeinteger是请求大小
page_tokenstring否翻页 token
parent_idsarray[string]否搜索目录列表
scopestring[enum]否搜索范围
all：全部；share_by_me：我发出的文件；share_to_me：我收到的文件；
latest：最近；personal_drive：我的云文档；group_drive：团队文档；
recycle：自定义；latest_opened：我打开过的；latest_edited：我编辑过的
search_operator_nameboolean否搜索文件的创建者或文件分享者
start_timeinteger否最小时间
time_typestring否时间范围，支持两种参数同时查询
ctime；mtime
typestring[enum]是搜索类型
file_name：文件名；content：正文；all：全部
with_driveboolean否是否返回驱动盘
with_linkboolean否是否返回文件分享信息
with_permissionboolean否是否返回文件操作权限
with_totalboolean否是否返回搜索到的总条数

提示： 如果 query 参数需要传递数组，传递的格式为：?key={value_1}&key={value_2}

请求地址示例 ​

[GET] https://openapi.wps.cn/v7/files/search?channels={string_1}&channels={string_2}&creator_ids={string_1}&creator_ids={string_2}

响应体 ​

名称参数类型说明
codeinteger响应代码。非 0 表示失败，参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]数据集合
∟ ∟ fileobject文件信息，与 file 定义一致
∟ ∟ ∟ created_byobject创建者
∟ ∟ ∟ ∟ avatarstring创建者头像
∟ ∟ ∟ ∟ company_idstring创建者企业 id
∟ ∟ ∟ ∟ idstring创建者 id
∟ ∟ ∟ ∟ namestring创建者名称
∟ ∟ ∟ ∟ typestring[enum]身份类型
user：用户；sp：服务主体
∟ ∟ ∟ ctimeinteger创建时间
∟ ∟ ∟ driveobject盘
∟ ∟ ∟ ∟ allotee_idstring盘归属身份 id
∟ ∟ ∟ ∟ allotee_typestring[enum]盘归属身份类型
user：用户；group：用户组；app：应用
∟ ∟ ∟ ∟ company_idstring企业 id
∟ ∟ ∟ ∟ created_byobject创建者
∟ ∟ ∟ ∟ ctimeinteger创建时间
∟ ∟ ∟ ∟ descriptionstring盘描述
∟ ∟ ∟ ∟ ext_attrsarray[object]盘扩展属性
∟ ∟ ∟ ∟ idstring驱动盘 id
∟ ∟ ∟ ∟ mtimeinteger修改时间
∟ ∟ ∟ ∟ namestring驱动盘名称
∟ ∟ ∟ ∟ quotaobject盘容量
∟ ∟ ∟ ∟ sourcestring盘来源
∟ ∟ ∟ ∟ statusstring[enum]盘状态
inuse：使用中；deleted：已删除
∟ ∟ ∟ drive_idstring盘 id
∟ ∟ ∟ ext_attrsarray[object]文件扩展属性
∟ ∟ ∟ ∟ namestring属性名
∟ ∟ ∟ ∟ valuestring属性值
∟ ∟ ∟ idstring文件 id
∟ ∟ ∟ link_idstring分享 id
∟ ∟ ∟ link_urlstring分享链接 url
∟ ∟ ∟ modified_byobject修改者
∟ ∟ ∟ ∟ avatarstring修改者头像
∟ ∟ ∟ ∟ company_idstring修改者企业 id
∟ ∟ ∟ ∟ idstring修改者 id
∟ ∟ ∟ ∟ namestring修改者名称
∟ ∟ ∟ ∟ typestring[enum]身份类型
user：用户；sp：服务主体
∟ ∟ ∟ mtimeinteger修改时间
∟ ∟ ∟ namestring名称
∟ ∟ ∟ parent_idstring父路径 id
∟ ∟ ∟ permissionobject文件权限
∟ ∟ ∟ ∟ commentboolean评论
∟ ∟ ∟ ∟ copyboolean复制
∟ ∟ ∟ ∟ copy_contentboolean内容复制
∟ ∟ ∟ ∟ deleteboolean文件删除
∟ ∟ ∟ ∟ downloadboolean下载
∟ ∟ ∟ ∟ historyboolean历史版本，仅公网支持
∟ ∟ ∟ ∟ moveboolean文件移动
∟ ∟ ∟ ∟ new_emptyboolean新建
∟ ∟ ∟ ∟ perm_ctlboolean权限管理
∟ ∟ ∟ ∟ printboolean打印
∟ ∟ ∟ ∟ renameboolean文件重命名
∟ ∟ ∟ ∟ saveasboolean另存为，仅公网支持
∟ ∟ ∟ ∟ secretboolean安全文档，仅公网支持
∟ ∟ ∟ ∟ shareboolean分享
∟ ∟ ∟ ∟ updateboolean编辑 / 更新
∟ ∟ ∟ ∟ uploadboolean上传：手动上传新版本
∟ ∟ ∟ sharedboolean是否开启分享
当 link.status=open 时，shared 为 true，其他结果为 false。
若调用方想提前知道文档是否分享但又不想额外调用分享信息，可使用此字段
∟ ∟ ∟ sizeinteger大小
∟ ∟ ∟ typestring文件类型
folder：文件夹；file：文件；shortcut：快捷方式
∟ ∟ ∟ versioninteger版本
∟ ∟ file_srcobject文件位置
∟ ∟ ∟ namestring来源名称
∟ ∟ ∟ pathstring文件路径
∟ ∟ ∟ typestring[enum]来源类型
link；user_private；user_roaming；group_normal；group_dept；group_whole
link 对应 name：我收到的；user 对应 name：我的云文档，我的漫游箱；group 对应 name：团队名
∟ ∟ highlightsobject匹配关键字
∟ next_page_tokenstring下一页 token
∟ totalinteger资源集合总数
moreobject更多的错误信息

响应体示例 ​

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "file": {
          "created_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "string[enum]"
          },
          "ctime": 0,
          "drive": {
            "allotee_id": "string",
            "allotee_type": "string[enum]",
            "company_id": "string",
            "created_by": "object",
            "ctime": 0,
            "description": "string",
            "ext_attrs": [],
            "id": "string",
            "mtime": 0,
            "name": "string",
            "quota": "object",
            "source": "string",
            "status": "string[enum]"
          },
          "drive_id": "string",
          "ext_attrs": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "id": "string",
          "link_id": "string",
          "link_url": "string",
          "modified_by": {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "string[enum]"
          },
          "mtime": 0,
          "name": "string",
          "parent_id": "string",
          "permission": {
            "comment": false,
            "copy": false,
            "copy_content": false,
            "delete": false,
            "download": false,
            "history": false,
            "move": false,
            "new_empty": false,
            "perm_ctl": false,
            "print": false,
            "rename": false,
            "saveas": false,
            "secret": false,
            "share": false,
            "update": false,
            "upload": false
          },
          "shared": false,
          "size": 0,
          "type": "string",
          "version": 0
        },
        "file_src": {
          "name": "string",
          "path": "string",
          "type": "string[enum]"
        },
        "highlights": "object"
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "msg": "string"
}
回到旧版