获取文档纯文本内容
获取文档的纯文本内容。
Tip: 应用频率限制：单个应用调用频率上限为每秒 5 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400。当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。
前提条件
调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有云文档的阅读、编辑等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考如何为应用或用户开通文档权限。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/docx/v1/documents/:document_id/raw_content |
| HTTP Method | GET |
| 接口频率限制 | 特殊频控 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | docx:document 创建及编辑新版文档 docx:document:readonly 查看新版文档 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
document_id | string | 文档的唯一标识。点击这里了解如何获取文档的 document_id示例值："doxbcmEtbFrbbq10nPNu8gabcef" 数据校验规则： - 长度范围： 27 ～ 27 字符 |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
lang | int | 否 | 指定返回的 MentionUser 即 @用户 的语言 示例值：0 可选值有： - 0: 该用户的默认名称。如：@张敏 - 1: 该用户的英文名称。如：@Min Zhang - 2: 暂不支持该枚举，使用时返回该用户的默认名称默认值： 0 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ content | string | 文档纯文本 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"content": "云文档\n多人实时协同，插入一切元素。不仅是在线文档，更是强大的创作和互动工具\n云文档：专为协作而生\n"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1770001 | invalid param | 确认传入的参数是否合法 |
| 404 | 1770002 | not found | 文档的 document_id 不存在。请确认文档是否已被删除或 document_id 是否填写正确。参考文档概述了解如何获取文档的 document_id |
| 400 | 1770003 | resource deleted | 确认资源是否已被删除 |
| 400 | 1770004 | too many blocks in document | 确认文档 Block 数量是否超上限 |
| 400 | 1770005 | too deep level in document | 确认文档 Block 层级是否超上限 |
| 400 | 1770006 | schema mismatch | 确认文档结构是否合法 |
| 400 | 1770007 | too many children in block | 确认指定 Block 的 Children 数量是否超上限 |
| 400 | 1770008 | too big file size | 确认上传的文件尺寸是否超上限 |
| 400 | 1770010 | too many table column | 确认表格列数是否超上限 |
| 400 | 1770011 | too many table cell | 确认表格单元格数量是否超上限 |
| 400 | 1770012 | too many grid column | 确认 Grid 列数量是否超上限 |
| 400 | 1770013 | relation mismatch | 图片、文件等资源的关联关系不正确。请确保在创建图片、文件块时，同时上传了相关图片或文件素材至对应的文档块中。详情参考文档常见问题 3 和 4 |
| 400 | 1770014 | parent children relation mismatch | 确认 Block 父子关系是否正确 |
| 400 | 1770015 | single edit with multi document | 确认 Block 所属文档与指定的 Document 是否相同 |
| 400 | 1770019 | repeated blockID in document | 确认 Document 中的 BlockID 是否有重复 |
| 400 | 1770020 | operation denied on copying document | 确认 Document 是否正在创建副本中 |
| 400 | 1770021 | too old document | 确认指定的 Document 版本过旧 |
| 400 | 1770022 | invalid page token | 确认查询参数中的 page_token 是否合法 |
| 400 | 1770024 | invalid operation | 确认操作是否合法 |
| 400 | 1770025 | operation and block not match | 确认指定 Block 应用对应操作是否合法 |
| 400 | 1770026 | row operation over range | 确认行操作下标是否越界 |
| 400 | 1770027 | column operation over range | 确认列操作下标是否越界 |
| 400 | 1770028 | block not support create children | 确认指定 Block 添加 Children 是否合法 |
| 400 | 1770029 | block not support to create | 确认指定 Block 是否支持创建 |
| 400 | 1770030 | invalid parent children relation | 确认指定操作其父子关系是否合法 |
| 400 | 1770031 | block not support to delete children | 确认指定 Block 是否支持删除 Children |
| 400 | 1770033 | raw content size exceed limited | 纯文本内容大小超过限制 |
| 400 | 1770034 | operation count exceed limited | 当前请求中涉及单元格个数过多，请拆分成多次请求 |
| 403 | 1770032 | forbidden | 确认当前调用身份是否有文档阅读（获取相关接口）或编辑（更新、删除、创建相关接口）权限。请参考以下方式解决： - 如果你使用的是 tenant_access_token，意味着当前应用没有文档权限。你需通过云文档网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加文档权限。 说明：在 添加文档应用 前，你需确保目标应用至少开通了一个云文档或多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。  - 如果你使用的是 user_access_token，意味着当前用户没有文档权限。你需通过云文档网页页面右上方 分享 入口为当前用户添加文档权限。  了解具体操作步骤或其它添加权限方式，参考云文档常见问题 3。 对于创建和更新相关接口，你还需要确认： - 当前调用身份是否有 MentionDoc 即 @文档 中文档的阅读权限 - MentionUser 即 @用户 中的用户是否在职且与当前调用身份互为联系人 - 当前调用身份是否具有群卡片的查看和分享权限 - 当前调用身份是否具有访问指定 Wiki 即知识库子目录的权限 - 当前调用身份是否具有 OKR、ISV、Add-Ons 等文档块的查看权限 |
| 500 | 1771001 | server internal error | 服务器内部错误 |
| 500 | 1771006 | mount folder failed | 挂载文档到云空间文件夹失败 |
| 500 | 1771002 | gateway server internal error | 网关服务内部错误 |
| 500 | 1771003 | gateway marshal error | 网关服务解析错误 |
| 500 | 1771004 | gateway unmarshal error | 网关服务反解析错误 |
| 503 | 1771005 | system under maintenance | 系统服务正在维护中 |