获取文档所有块
GET
https://open.feishu.cn/open-apis/docx/v1/documents/{document_id}/blocks
错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1770001 | invalid param | 确认传入的参数是否合法 |
| 404 | 1770002 | not found | 确认文档是否已被删除 |
| 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 | 确认图片、文件等资源的关联关系是否正确，插入图片、文件需先上传素材 |
| 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 | 确认 DocumentID 是否合法 |
| 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 | 确认是否拥有合法权限 |
| 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 | 系统服务正在维护中 |
请求示例请求示例
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
curl --location --request GET 'https://open.feishu.cn/open-apis/docx/v1/documents/doxcnePuYufKa49ISjhD8Ih0ikh/blocks' \
--header 'Authorization;'响应示例响应示例
{
"code": 0,
"data": {
"has_more": false,
"items": [
{
"block_id": "doxcnAJ9VRRJqVMYZ1MyKnayXWe",
"block_type": 1,
"children": [
"doxcnC4cO4qUui6isgnpofh5edc",
"doxcn4w8uwwoycMOqw1jRxL0qyb",
"doxcnc2UgKK6ssQW0sbUuli1kte",
"doxcnIaciiikamkwaMTLWsWntQf"
],
"page": {
"elements": [
{
"text_run": {
"content": "云文档",
"text_element_style": {}
}
}
],
"style": {}
},
"parent_id": ""
},
{
"block_id": "doxcnC4cO4qUui6isgnpofh5edc",
"block_type": 2,
"parent_id": "doxcnAJ9VRRJqVMYZ1MyKnayXWe",
"text": {
"elements": [
{
"text_run": {
"content": "云文档：专为协作而生",
"text_element_style": {
"link": {
"url": "https%3A%2F%2Fbytedance.feishu.cn%2Fdrive%2Fhome%2F"
}
}
}
}
],
"style": {}
}
},
{
"block_id": "doxcn4w8uwwoycMOqw1jRxL0qyb",
"block_type": 2,
"parent_id": "doxcnAJ9VRRJqVMYZ1MyKnayXWe",
"text": {
"elements": [
{
"text_run": {
"content": "多人实时协同，插入一切元素。不仅是在线文档，更是",
"text_element_style": {
"background_color": 15,
"text_color": 5
}
}
},
{
"text_run": {
"content": "强大的创作和互动工具",
"text_element_style": {
"background_color": 15,
"bold": true,
"text_color": 5
}
}
}
],
"style": {}
}
},
{
"block_id": "doxcnc2UgKK6ssQW0sbUuli1kte",
"block_type": 2,
"parent_id": "doxcnAJ9VRRJqVMYZ1MyKnayXWe",
"text": {
"style": {}
}
},
{
"block_id": "doxcnIaciiikamkwaMTLWsWntQf",
"block_type": 2,
"parent_id": "doxcnAJ9VRRJqVMYZ1MyKnayXWe",
"text": {
"style": {}
}
}
]
},
"msg": ""
}请求参数
Path 参数
document_id
string
文档的唯一标识
示例值:
doxcnePuYufKa49ISjhD8Ih0ikh
Query 参数
page_size
string
可选
page_token
string
可选
示例值:
aw7DoMKBFMOGwqHCrcO8w6jCmMOvw6ILeADCvsKNw57Di8O5XGV3LG4_w5HCqhFxSnDCrCzCn0BgZcOYUg85EMOYcEAcwqYOw4ojw5QFwofCu8KoIMO3K8Ktw4IuNMOBBHNYw4bCgCV3U1zDu8K-J8KSR8Kgw7Y0fsKZdsKvW3d9w53DnkHDrcO5bDkYwrvDisOEPcOtVFJ-I03CnsOILMOoAmLDknd6dsKqG1bClAjDuS3CvcOTwo7Dg8OrwovDsRdqIcKxw5HDohTDtXN9w5rCkWo
document_revision_id
string
可选
user_id_type
string
可选
Header 参数
Authorization
string
必需
默认值:
Bearer {{access_token}}
Content-Type
string
必需
默认值:
application/json; charset=utf-8
返回响应
扫码加入交流群