获取文件预览或编辑信息新版SDK
更新于 2023-06-06调用本接口,获取文件预览或编辑的链接。
调用本接口,可获取存储空间内文件的预览或编辑链接,拥有权限的用户可通过链接对文件进行预览或编辑操作。
权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 企业存储文件读权限 | API Explorer |
第三方企业应用 | 支持 | 企业存储文件读权限 | API Explorer |
第三方个人应用 | 暂不支持 | 企业存储文件读权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Path参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
spaceId | String | 是 | 空间Id。 |
dentryId | String | 是 | 文件Id。
|
Query参数
Body参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
option | Object | 否 | 可选参数。 |
version | Long | 否 | 指定文件的版本号。 说明
不填表示最新版本。 |
type | String | 否 | 文件的打开方式。
|
waterMark | Boolean | 否 | 是否需要水印。
说明
目前仅WPS格式文件(Word、Excel、PPT、Pdf)支持水印。 |
checkLogin | Boolean | 否 | 是否检查钉钉登录态,目前仅对type参数值为PREVIEW时生效。
|
返回参数
名称 | 类型 | 描述 |
---|---|---|
url | String | 文件链接。 |
hasWaterMark | Boolean | 是否支持水印。
|
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | paramError | %s | 参数错误 |
400 | paramError.spaceId | %s | 参数错误-spaceId |
400 | paramError.dentryId | %s | 参数错误-dentryId |
400 | paramError.openType | %s | 参数错误-openType |
400 | dentryEditNotSupport | %s | 文件不支持编辑 |
400 | dentryPreviewNotSupport | %s | 文件不支持预览 |
400 | dentryExtensionNotSupport | %s | 文件后缀不支持 |
400 | fileViral | %s | 病毒文件 |
400 | fileMalicious | %s | 恶意文件 |
403 | permissionDenied | %s | 用户缺少读取文件的权限 |
404 | spaceNotExist | %s | 空间不存在 |
404 | dentryNotExist | %s | 文件不存在 |
500 | systemError | %s | 系统错误 |
500 | unknownError | Unknown Error | 未知错误 |
503 | operationTimeout | %s | 请求超时 |