企业内部开发 服务端API 效率工具 微盘 文件管理
文件管理

目录

  • 获取文件列表
  • 上传文件
  • 下载文件
  • 新建文件/微文档
  • 重命名文件
  • 移动文件
  • 删除文件
  • 文件信息
  • 获取文件列表

    该接口用于获取指定地址下的文件列表。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_list?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
    	"spaceid": "SPACEID",
    	"fatherid": "FATHERID",
    	"sort_type": SORT_TYPE,
    	"start": START,
    	"limit": LIMIT
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    spaceidstring空间spaceid
    fatheridstring当前目录的fileid,根目录时为空间spaceid
    sort_typeuint32列表排序方式 1:名字升序;2:名字降序;3:大小升序;4:大小降序;5:修改时间升序;6:修改时间降序
    startuint32首次填0, 后续填上一次请求返回的next_start
    limituint32分批拉取最大文件数, 不超过1000

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"has_more": true,
    	"next_start": NEXT_START,
    	"file_list": {
    		"item": [{
    			"fileid": "FILEID1",
    			"file_name": "FILE_NAME1",
                "spaceid": "SPACEID",
                "fatherid": "FATHERID",
                "file_size": FILE_SIZE,
                "ctime": CTIME,
                "mtime": MTIME,
                "file_type": FILE_TYPE,
                "file_status": FILE_STATUS,
                "create_userid": "CREATE_USERID",
                "update_userid": "UPDATE_USERID",
                "sha": "SHA",
                "md5": "MD5",
    			"url": "URL"
    		}, {
    			"fileid": "FILEID2",
    			"file_name": "FILE_NAME2"
    		}]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    has_morebooltrue为列表还有内容, 需要继续分批拉取
    next_startuint32下次分批拉取对应的请求参数start值
    file_listobj[]文件列表
    fileidstring文件fileid
    file_namestring文件名字
    spaceidstring文件所在的空间spaceid
    fatheridstring文件所在的目录fileid, 在根目录时为fileid
    file_sizeuint64文件大小
    ctimeuint64文件创建时间
    mtimeuint64文件最后修改时间
    file_typeuint32文件类型, 1:文件夹 2:文件 3:微文档(文档) 4:微文档(表格) 5:微文档(收集表)
    file_statusuint32文件状态, 1:正常 2:删除
    create_useridstring文件创建者userid
    update_useridstring文件最后修改者userid
    shastring文件sha
    md5string文件md5
    urlstring仅微文档类型返回访问链接

    上传文件

    该接口用于向微盘中的指定位置上传文件。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_upload?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
    	"spaceid": "SPACEID",
    	"fatherid": "FATHERID",
    	"file_name": "FILE_NAME",
    	"file_base64_content": "FILE_BASE64_CONTENT"
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    spaceidstring空间spaceid
    fatheridstring父目录fileid, 在根目录时为空间spaceid
    file_namestring文件名字
    file_base64_contentstring文件内容base64(注意:只需要填入文件内容的Base64,不需要添加任何如:"data:application/x-javascript;base64" 的数据类型描述信息)

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"fileid": "FILEID"
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    fileidstring新建文件的fielid

    下载文件

    该接口用于下载文件,请求的userid需有下载权限。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_download?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
    	"fileid": "FILEID"
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    fileidstring文件fileid(只支持下载普通文件,不支持下载文件夹或微文档)

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"download_url": "DOWNLOAD_URL",
    	"cookie_name": "COOKIE_NAME",
    	"cookie_value": "COOKIE_VALUE"
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    download_urlstring下载请求url (有效期2个小时)
    cookie_namestring下载请求带cookie的key
    cookie_valuestring下载请求带cookie的value

    新建文件/微文档

    该接口用于在微盘指定位置新建文件、微文档。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_create?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
    	"spaceid": "SPACEID",
    	"fatherid": "FATHERID",
    	"file_type": "FILE_TYPE",
    	"file_name": "FILE_NAME"
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    spaceidstring空间spaceid
    fatheridstring父目录fileid, 在根目录时为空间spaceid
    file_typeuint32文件类型, 1:文件夹 3:微文档(文档) 4:微文档(表格)
    file_namestring文件名字

     

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"fileid": "FILEID",
    	"url": "URL"
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    fileidstring新建文件的fileid
    urlstring微文档的访问链接,仅在新建微文档时返回

    重命名文件

    该接口用于对指定文件进行重命名。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_rename?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
    	"fileid": "FILEID",
    	"new_name": "NEW_NAME"
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    fileidstring文件fileid
    new_namestring重命名后的文件名

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
        "file": {
    		"fileid": "FILEID",
    		"file_name": "FILE_NAME",
            "spaceid": "SPACEID",
            "fatherid": "FATHERID",
            "file_size": FILE_SIZE,
            "ctime": CTIME,
            "mtime": MTIME,
            "file_type": FILE_TYPE,
            "file_status": FILE_STATUS,
            "create_userid": "CREATE_USERID",
            "update_userid": "UPDATE_USERID",
            "sha": "SHA",
            "md5": "MD5" 
        }
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    fileidstring文件fileid
    file_namestring文件名字
    spaceidstring文件所在的空间spaceid
    fatheridstring文件所在的目录fileid, 在根目录时为spaceid
    file_sizeuint64文件大小
    ctimeuint64文件创建时间
    mtimeuint64文件最后修改时间
    file_typeuint32文件类型, 1:文件夹 2:文件 3:微文档(文档) 4:微文档(表格) 5:微文档(收集表)
    file_statusuint32文件状态, 1:正常 2:删除
    create_useridstring文件创建者userid
    update_useridstring文件最后修改者userid
    shastring文件sha
    md5string文件md5

    移动文件

    该接口用于将文件移动到指定位置。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_move?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
        "fatherid": "FATHERID",
        "replace": true,
    	"fileid": ["FILEID1", "FILEID2"]
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    fatheridstring当前目录的fileid,根目录时为空间spaceid
    replacebool如果移动到的目标目录与需要移动的文件重名时,是否覆盖。true:重名文件覆盖 false:重名文件进行冲突重命名处理(移动后文件名格式如xxx(1).txt xxx(1).doc等)
    fileidstring文件fileid

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
        "file_list": {
            "item": [
                 {
                "fileid": "FILEID",
    	    	"file_name": "FILE_NAME",
                "spaceid": "SPACEID",
                "fatherid": "FATHERID",
                "file_size": FILE_SIZE,
                "ctime": CTIME,
                "mtime": MTIME,
                "file_type": FILE_TYPE,
                "file_status": FILE_STATUS,
                "create_userid": "CREATE_USERID",
                "update_userid": "UPDATE_USERID",
                "sha": "SHA",
                "md5": "MD5" 
                 }
            ]
        }
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    file_listobj[]移动文件的信息列表
    fileidstring文件fileid
    file_namestring文件名字
    spaceidstring文件所在的空间spaceid
    fatheridstring文件所在的目录fileid, 在根目录时为fileid
    file_sizeuint64文件大小
    ctimeuint64文件创建时间
    mtimeuint64文件最后修改时间
    file_typeuint32文件类型, 1:文件夹 2:文件 3:微文档(文档) 4:微文档(表格) 5:微文档(收集表)
    file_statusuint32文件状态, 1:正常 2:删除
    create_useridstring文件创建者userid
    update_useridstring文件最后修改者userid
    shastring文件sha
    md5string文件md5

     

    删除文件

    该接口用于删除指定文件。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_delete?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
    	"fileid": ["FILEID1", "FILEID2"]
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    fileidstring[]文件fileid

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok"
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明

    文件信息

    该接口用于获取指定文件的信息。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_info?access_token=ACCESS_TOKEN

    请求包体

    {
    	"userid": "USERID",
    	"fileid": "FILEID"
    }

    参数说明

    参数类型是否必须说明
    useridstring操作者userid
    fileidstring文件fileid

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"file_info": {
    		"fileid": "FILEID",
    		"file_name": "FILE_NAME",
            "spaceid": "SPACEID",
            "fatherid": "FATHERID",
            "file_size": FILE_SIZE,
            "ctime": CTIME,
            "mtime": MTIME,
            "file_type": FILE_TYPE,
            "file_status": FILE_STATUS,
            "create_userid": "CREATE_USERID",
            "update_userid": "UPDATE_USERID",
            "sha": "SHA",
            "md5": "MD5",
    		"url": "URL"
        }
    }
    

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    fileidstring文件fileid
    file_namestring文件名字
    spaceidstring文件所在的空间spaceid
    fatheridstring文件所在的目录fileid, 在根目录时为fileid
    file_sizeuint64文件大小
    ctimeuint64文件创建时间
    mtimeuint64文件最后修改时间
    file_typeuint321: 文件夹 2:文件 3: 微文档(文档) 4: 微文档(表格) 5:微文档(收集表)
    file_statusuint32文件状态, 1:正常 2:删除
    create_useridstring文件创建者userid
    update_useridstring文件最后修改者userid
    shastring文件sha
    md5string文件md5
    urlstring仅微文档类型返回访问链接
    上一篇
    空间权限
    下一篇
    文件权限