选择应用类型
第三方企业应用开发
学习地图
动态与公告
应用开发平台简介(新版)
应用开发平台简介
开发应用(新版)
开发应用
服务端API
开发指南
API总览
身份验证(免登)
应用授权
获取访问凭证
钉钉统一授权套件
通讯录管理
上下游组织(原合作空间)
上下级组织(原关联组织)
考勤
日程
日志
签到
服务窗
音视频
钉工牌
OA审批
即时通信IM
待办任务
智能填表
组织大脑
智能人事
互动卡片
企业文化
专属开放
钉钉客联
行业开放
生态开放
应用市场
智能招聘
智能硬件
文档/文件
知识库
钉盘
群文件
媒体文件
文档
搜索
存储管理
概述
权限申请
企业管理
应用管理
空间管理
文件管理
添加文件夹
复制文件或文件夹
批量复制文件或文件夹
移动文件或文件夹
批量移动文件或文件夹
重命名文件或文件夹
删除文件或文件夹
批量删除文件或文件夹
恢复文件历史版本
获取文件版本列表
获取文件或文件夹信息
批量获取文件或文件夹信息
获取空间下所有文件或文件夹列表
获取文件或文件夹列表
更新文件或文件夹的应用属性
删除文件或文件夹的应用属性
获取文件预览或编辑信息
批量获取文件缩略图
文件传输
权限管理
回收站管理
任务管理
事件订阅
HCM 主数据
钉钉碳中和
宜搭应用开发
客户管理
Teambition 项目管理
钉钉快办
Agoal
炼丹炉(模型服务)
AI 助理
365会员
附录
客户端API
AppLink协议
事件订阅
常见问题
运营规范
历史文档

获取文件预览或编辑信息新版SDK

更新于 2023-06-06调用本接口,获取文件预览或编辑的链接。

调用本接口,可获取存储空间内文件的预览或编辑链接,拥有权限的用户可通过链接对文件进行预览或编辑操作。

权限

要调用此API,需要以下权限之一。

应用类型

是否支持

权限

API Explorer调试

企业内部应用支持企业存储文件读权限API Explorer
第三方企业应用支持企业存储文件读权限API Explorer
第三方个人应用暂不支持企业存储文件读权限暂不支持

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Path参数

名称

类型

是否必填

描述

spaceId

String

空间Id。

  • 企业内部应用,调用添加空间接口获取id参数值。

  • 第三方企业应用,调用添加空间接口获取id参数值。

dentryId

String

文件Id。

Query参数

名称

类型

是否必填

描述

unionId

String

操作用户unionId。

Body参数

名称

类型

是否必填

描述

option

Object

可选参数。

version

Long

指定文件的版本号。

说明

不填表示最新版本。

type

String

文件的打开方式。

  • PREVIEW:预览,默认值

  • EDIT:编辑

waterMark

Boolean

是否需要水印。

  • true:需要

  • false:不需要,默认值

说明

目前仅WPS格式文件(Word、Excel、PPT、Pdf)支持水印。

checkLogin

Boolean

是否检查钉钉登录态,目前仅对type参数值为PREVIEW时生效。

  • true:检查

    • 设置为true时,进入页面时会校验钉钉登录态。如果没有登录态,会跳转到登录页面,登录成功后继续跳转到当前页面。
  • false:不检查,默认值

    • 设置为false时,进入页面后不校验钉钉登录态,但有以下限制:

      • 支持基础文档格式文件(Word、Excel、PPT、Pdf)、部分图片格式(jpg、jpeg、jpe、png、gif、bmp、pcx、jiff、tiff、tif、ico、fax、wbmp、webp)和所有类型音视频文件。预览窗口右上角不支持转发副本、在线编辑、下载等功能操作。

      • 链接获取后,只能被访问一次(针对浏览器session)。

      • 链接获取后,5分钟不使用会自动失效。

返回参数

名称

类型

描述

url

String

文件链接。

hasWaterMark

Boolean

是否支持水印。

  • true:支持

  • false:不支持

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

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

请求超时

点击纠错