目录
该接口用于获取指定地址下的文件列表。
请求方式: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
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
spaceid | string | 是 | 空间spaceid |
fatherid | string | 是 | 当前目录的fileid,根目录时为空间spaceid |
sort_type | uint32 | 是 | 列表排序方式 1:名字升序;2:名字降序;3:大小升序;4:大小降序;5:修改时间升序;6:修改时间降序 |
start | uint32 | 是 | 首次填0, 后续填上一次请求返回的next_start |
limit | uint32 | 是 | 分批拉取最大文件数, 不超过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"
}]
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
has_more | bool | true为列表还有内容, 需要继续分批拉取 |
next_start | uint32 | 下次分批拉取对应的请求参数start值 |
file_list | obj[] | 文件列表 |
fileid | string | 文件fileid |
file_name | string | 文件名字 |
spaceid | string | 文件所在的空间spaceid |
fatherid | string | 文件所在的目录fileid, 在根目录时为fileid |
file_size | uint64 | 文件大小 |
ctime | uint64 | 文件创建时间 |
mtime | uint64 | 文件最后修改时间 |
file_type | uint32 | 文件类型, 1:文件夹 2:文件 3:微文档(文档) 4:微文档(表格) 5:微文档(收集表) |
file_status | uint32 | 文件状态, 1:正常 2:删除 |
create_userid | string | 文件创建者userid |
update_userid | string | 文件最后修改者userid |
sha | string | 文件sha |
md5 | string | 文件md5 |
url | string | 仅微文档类型返回访问链接 |
该接口用于向微盘中的指定位置上传文件。
请求方式: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"
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
spaceid | string | 是 | 空间spaceid |
fatherid | string | 是 | 父目录fileid, 在根目录时为空间spaceid |
file_name | string | 是 | 文件名字 |
file_base64_content | string | 是 | 文件内容base64(注意:只需要填入文件内容的Base64,不需要添加任何如:"data:application/x-javascript;base64" 的数据类型描述信息) |
返回示例
{
"errcode": 0,
"errmsg": "ok",
"fileid": "FILEID"
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
fileid | string | 新建文件的fielid |
该接口用于下载文件,请求的userid需有下载权限。
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_download?access_token=ACCESS_TOKEN
请求包体
{
"userid": "USERID",
"fileid": "FILEID"
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
fileid | string | 是 | 文件fileid(只支持下载普通文件,不支持下载文件夹或微文档) |
返回示例
{
"errcode": 0,
"errmsg": "ok",
"download_url": "DOWNLOAD_URL",
"cookie_name": "COOKIE_NAME",
"cookie_value": "COOKIE_VALUE"
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
download_url | string | 下载请求url (有效期2个小时) |
cookie_name | string | 下载请求带cookie的key |
cookie_value | string | 下载请求带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"
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
spaceid | string | 是 | 空间spaceid |
fatherid | string | 是 | 父目录fileid, 在根目录时为空间spaceid |
file_type | uint32 | 是 | 文件类型, 1:文件夹 3:微文档(文档) 4:微文档(表格) |
file_name | string | 是 | 文件名字 |
返回示例
{
"errcode": 0,
"errmsg": "ok",
"fileid": "FILEID",
"url": "URL"
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
fileid | string | 新建文件的fileid |
url | string | 微文档的访问链接,仅在新建微文档时返回 |
该接口用于对指定文件进行重命名。
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_rename?access_token=ACCESS_TOKEN
请求包体
{
"userid": "USERID",
"fileid": "FILEID",
"new_name": "NEW_NAME"
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
fileid | string | 是 | 文件fileid |
new_name | string | 是 | 重命名后的文件名 |
返回示例
{
"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"
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
fileid | string | 文件fileid |
file_name | string | 文件名字 |
spaceid | string | 文件所在的空间spaceid |
fatherid | string | 文件所在的目录fileid, 在根目录时为spaceid |
file_size | uint64 | 文件大小 |
ctime | uint64 | 文件创建时间 |
mtime | uint64 | 文件最后修改时间 |
file_type | uint32 | 文件类型, 1:文件夹 2:文件 3:微文档(文档) 4:微文档(表格) 5:微文档(收集表) |
file_status | uint32 | 文件状态, 1:正常 2:删除 |
create_userid | string | 文件创建者userid |
update_userid | string | 文件最后修改者userid |
sha | string | 文件sha |
md5 | string | 文件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"]
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
fatherid | string | 是 | 当前目录的fileid,根目录时为空间spaceid |
replace | bool | 否 | 如果移动到的目标目录与需要移动的文件重名时,是否覆盖。true:重名文件覆盖 false:重名文件进行冲突重命名处理(移动后文件名格式如xxx(1).txt xxx(1).doc等) |
fileid | string | 是 | 文件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"
}
]
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
file_list | obj[] | 移动文件的信息列表 |
fileid | string | 文件fileid |
file_name | string | 文件名字 |
spaceid | string | 文件所在的空间spaceid |
fatherid | string | 文件所在的目录fileid, 在根目录时为fileid |
file_size | uint64 | 文件大小 |
ctime | uint64 | 文件创建时间 |
mtime | uint64 | 文件最后修改时间 |
file_type | uint32 | 文件类型, 1:文件夹 2:文件 3:微文档(文档) 4:微文档(表格) 5:微文档(收集表) |
file_status | uint32 | 文件状态, 1:正常 2:删除 |
create_userid | string | 文件创建者userid |
update_userid | string | 文件最后修改者userid |
sha | string | 文件sha |
md5 | string | 文件md5 |
该接口用于删除指定文件。
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_delete?access_token=ACCESS_TOKEN
请求包体
{
"userid": "USERID",
"fileid": ["FILEID1", "FILEID2"]
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
fileid | string[] | 是 | 文件fileid |
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
该接口用于获取指定文件的信息。
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedrive/file_info?access_token=ACCESS_TOKEN
请求包体
{
"userid": "USERID",
"fileid": "FILEID"
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
userid | string | 是 | 操作者userid |
fileid | string | 是 | 文件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"
}
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
fileid | string | 文件fileid |
file_name | string | 文件名字 |
spaceid | string | 文件所在的空间spaceid |
fatherid | string | 文件所在的目录fileid, 在根目录时为fileid |
file_size | uint64 | 文件大小 |
ctime | uint64 | 文件创建时间 |
mtime | uint64 | 文件最后修改时间 |
file_type | uint32 | 1: 文件夹 2:文件 3: 微文档(文档) 4: 微文档(表格) 5:微文档(收集表) |
file_status | uint32 | 文件状态, 1:正常 2:删除 |
create_userid | string | 文件创建者userid |
update_userid | string | 文件最后修改者userid |
sha | string | 文件sha |
md5 | string | 文件md5 |
url | string | 仅微文档类型返回访问链接 |