概述

钉钉文档 OpenAPI 提供了一套 RESTful 风格的接口，允许开发者通过程序化方式操作钉钉文档。你可以使用这些接口实现文档内容的自动化读写、块元素的增删改查、内容批量操作等功能，适用于文档自动生成、内容同步、智能写作等场景。

​

什么是钉钉文档

钉钉文档是阿里巴巴集团钉钉自主研发的企业协同办公套件，其包含文档、表格、脑图等在线创作工具。在日常使用中，无需下载文档即可通过电脑、手机或平板直接编辑和查看文档内容，文档内容实时自动保存。 同时，钉钉文档与钉钉深度整合，可基于组织关系与同事高效协作。使用钉钉文档还可以用于信息收集、项目管理、会议、业务汇报和新人入职等日常工作场景。更多功能介绍，请参见钉钉使用手册-钉钉文档。

​

开放概览

​

开放接口列表

文档提供了丰富的接口开放能力，开发者通过API接口可以实现文档的基础操作。

​

回调事件列表

• 文档导出任务完成事件

​

名词解释

在使用钉钉文档 OpenAPI 之前，需要了解以下核心概念：

​

dentryUuid

文档的唯一标识。以https://docs.dingtalk.io/i/nodes/Z90D4da-id为例，dentryUuid就是Z90D4da-id。

​

blockId

块元素的唯一标识，可通过「查询块元素」接口获取。

​

operatorId

操作人的unionId，用于标识执行操作的用户身份和权限校验。

​

BlockElement

块元素，是文档内容的基本组成单位，如段落、标题、高亮块、表格等。

​

InlineElement

行内元素，嵌套在块元素内部，如贴纸、图片、链接、插槽等。