概述

在接入新版文档 OpenAPI 前，推荐先阅读新版文档 OpenAPI 接入指引。

文档

每篇文档都有唯一的 document_id 作为标识。

方法列表

方法 (API)	权限要求（满足任一）	访问凭证	商店	自建
`GET` 获取文档基本信息 /open-apis/docx/v1/documents/:document_id	创建及编辑新版文档查看新版文档	tenant_access_tokenuser_access_token	✓	✓
`GET` 获取文档纯文本内容 /open-apis/docx/v1/documents/:document_id/raw_content	创建及编辑新版文档查看新版文档	tenant_access_tokenuser_access_token	✓	✓
`GET` 获取文档所有块 /open-apis/docx/v1/documents/:document_id/blocks	创建及编辑新版文档查看新版文档	tenant_access_tokenuser_access_token	✓	✓
`POST` 创建文档 /open-apis/docx/v1/documents	创建及编辑新版文档	tenant_access_tokenuser_access_token	✓	✓

块

块作为文档内容结构化组成元素，是有着明确含义的信息单元。块有多种形式，可以是一段文字、一张电子表格或一张图片等。每个块都有唯一的 block_id 作为标识。

方法列表

方法 (API)	权限要求（满足任一）	访问凭证	商店	自建
`GET` 获取块 /open-apis/docx/v1/documents/:document_id/blocks/:block_id	创建及编辑新版文档查看新版文档	tenant_access_tokenuser_access_token	✓	✓
`POST` 创建块 /open-apis/docx/v1/documents/:document_id/blocks/:block_id/children	创建及编辑新版文档	tenant_access_tokenuser_access_token	✓	✓
`PATCH` 更新块 /open-apis/docx/v1/documents/:document_id/blocks/:block_id	创建及编辑新版文档	tenant_access_tokenuser_access_token	✓	✓
`PATCH` 批量更新块 /open-apis/docx/v1/documents/:document_id/blocks/batch_update	创建及编辑新版文档	tenant_access_tokenuser_access_token	✓	✓
`DELETE` 删除块 /open-apis/docx/v1/documents/:document_id/blocks/:block_id/children/batch_delete	创建及编辑新版文档	tenant_access_tokenuser_access_token	✓	✓
`GET` 获取所有子块 /open-apis/docx/v1/documents/:document_id/blocks/:block_id/children	创建及编辑新版文档查看新版文档	tenant_access_tokenuser_access_token	✓	✓

修改于 2023-01-13 08:29:52

新版文档接入指南