有奖捉虫:云通信与企业服务文档专题,速来> HOT

功能描述

用于下载文件。

接口说明

要求权限:
非 acl 鉴权:无
acl 鉴权:canDownload(当前文件夹可下载)
说明
非 acl 鉴权是指当前用户对所有文件的操作权限,详情可参考 生成访问令牌接口
acl 鉴权是通过共享授权接口给指定用户,以文件夹为单位授予的权限,详情可参考 角色授权模块
可以直接在使用文件的参数中指定该 URL,例如对于图片文件可直接在小程序 <image> 标签、 HTML <img> 标签或小程序 wx.previewImage 接口等中使用,该接口将自动 302 跳转到真实的图片 URL;视频和文件同理。

请求

请求示例

GET /api/v1/file/{LibraryId}/{SpaceId}/{FilePath}?history_id={HistoryId}&access_token={AccessToken}&user_id={UserId}
请求参数:
LibraryId:媒体库 ID,必选参数。
SpaceId:空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数。
FilePath:完整文件路径,例如 foo/bar/file.docx
HistoryId:历史版本 ID,用于获取不同版本的文件内容,可选参数,不传默认为最新版。
AccessToken:访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数。
UserId:用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅 生成访问令牌接口,可选参数。

响应

响应码

获取成功,返回 HTTP 302 Found。

响应头部

响应头部:
Location:包含可直接用于展示或下载的文件 URL。
x-smh-type:文件类型。
x-smh-creation-time:文件完成上传的时间。
x-smh-content-type:媒体类型。
x-smh-size:文件大小。
x-smh-etag:文件 ETag。
x-smh-crc64:文件的 CRC64-ECMA182 校验值,为了避免数字精度问题,这里为字符串格式。
x-smh-meta-*:自定义元数据。

响应体

该接口无响应体。