什么是钉钉文档
钉钉文档是阿里巴巴集团钉钉自主研发的企业协同办公套件,其包含文档、表格、脑图等在线创作工具。在日常使用中,无需下载文档即可通过电脑、手机或平板直接编辑和查看文档内容,文档内容实时自动保存。 同时,钉钉文档与钉钉深度整合,可基于组织关系与同事高效协作。使用钉钉文档还可以用于信息收集、项目管理、会议、业务汇报和新人入职等日常工作场景。更多功能介绍,请参见钉钉使用手册-钉钉文档。
开放概览
开放接口列表
文档提供了丰富的接口开放能力,开发者通过API接口可以实现文档的基础操作。| API | API说明 | API版本 |
|---|---|---|
| 覆写文档(个人授权) | 以 Markdown 格式覆写整篇文档内容。 说明 该方式需要用户授权后,才能调用该接口。 | 新版 |
| 覆写文档(应用授权) | 以 Markdown 格式覆写整篇文档内容。 说明 该方式通过应用凭证appKey、appSecret获取accessToken后即可调用。 | 新版 |
| 获取资源上传信息 | 查询文档指定资源的上传地址。 | 新版 |
| 插入内容 | 在文档指定位置插入一段 Markdown 内容。 | 新版 |
| 查询块元素 | 查询文档根节点下的一级块元素列表。 | 新版 |
| 插入块元素 | 在文档指定位置插入 1 个块元素。 | 新版 |
| 更新块元素 | 更新文档中任意 1 个块元素的内容或属性。 | 新版 |
| 删除块元素 | 删除文档中 1 个特定的块元素。 | 新版 |
| 在段落末尾追加文本 | 向指定段落末尾追加一段文本。 | 新版 |
| 在段落末尾追加行内元素 | 在指定段落末尾追加一个行内元素。 | 新版 |
回调事件列表
- 文档导出任务完成事件
名词解释
在使用钉钉文档 OpenAPI 之前,需要了解以下核心概念:dentryUuid
文档的唯一标识。以https://alidocs.dingtalk.io/i/nodes/Z90D4da-id为例,dentryUuid就是Z90D4da-id。
blockId
块元素的唯一标识,可通过「查询块元素」接口获取。operatorId
操作人的unionId,用于标识执行操作的用户身份和权限校验。