获取块的内容
指定块的 block id 获取指定块的富文本内容数据。
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/blocks/:block_id |
| HTTP Method | GET |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | docx:document 创建及编辑新版文档 docx:document:readonly 查看新版文档 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
document_id | string | 文档的唯一标识。点击这里了解如何获取文档的 document_id示例值:"doxcnePuYufKa49ISjhD8Iabcef" |
block_id | string | Block 的唯一标识。你可调用获取文档所有块获取文档中块的 block_id示例值:"doxcnO6UW6wAw2qIcYf4hZabcef" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
document_revision_id | int | 否 | 查询的文档版本,-1 表示文档最新版本。文档创建后,版本为 1。若查询的版本为文档最新版本,则需要持有文档的阅读权限;若查询的版本为文档的历史版本,则需要持有文档的编辑权限。你可通过调用获取文档基本信息获取文档的最新 revision_id 示例值:-1 默认值: -1数据校验规则: - 最小值: -1 |
user_id_type | string | 否 | 用户 ID 类型 示例值:"open_id" 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求示例
BASH
curl --location --request GET 'https://open.feishu.cn/open-apis/docx/v1/documents/doxcnAJ9VRRJqVMYZ1MyKnavXWe/blocks/doxcnC4cO4qUui6isgnpofh5edc?document_revision_id=-1' \
--header 'Authorization: Bearer u-xxx'
# 调用前请替换 'Authorization: Bearer u-xxx' 中的 'u-xxx' 为真实的访问令牌响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ block | block | 查询的 Block 的信息 |
└ block_id | string | 子块的唯一标识 |
└ parent_id | string | 子块的父块 ID |
└ children | string\[\] | 子块的子块 ID 列表 |
└ block_type | int | Block 类型 可选值有: - 1: 页面 Block - 2: 文本 Block - 3: 标题 1 Block - 4: 标题 2 Block - 5: 标题 3 Block - 6: 标题 4 Block - 7: 标题 5 Block - 8: 标题 6 Block - 9: 标题 7 Block - 10: 标题 8 Block - 11: 标题 9 Block - 12: 无序列表 Block - 13: 有序列表 Block - 14: 代码块 Block - 15: 引用 Block - 17: 待办事项 Block - 18: 多维表格 Block - 19: 高亮块 Block - 20: 会话卡片 Block - 21: 流程图 & UML Block - 22: 分割线 Block。为空结构体,需传入 {} 创建分割线 Block。 - 23: 文件 Block - 24: 分栏 Block - 25: 分栏列 Block - 26: 内嵌网页 Block - 27: 图片 Block - 28: 开放平台小组件 Block - 29: 思维笔记 Block - 30: 电子表格 Block - 31: 表格 Block。了解如何在文档中插入表格,参考文档常见问题-如何插入表格并往单元格填充内容。 - 32: 表格单元格 Block - 33: 视图 Block - 34: 引用容器 Block。为空结构体,需传入 {} 创建引用容器 Block。 - 35: 任务 Block - 36: OKR Block - 37: OKR Objective Block - 38: OKR Key Result Block - 39: OKR 进展 Block - 40: 文档小组件 Block - 41: Jira 问题 Block - 42: Wiki 子目录 Block - 43: 画板 Block - 44: 议程 Block - 45: 议程项 Block - 46: 议程项标题 Block - 47: 议程项内容 Block - 48: 链接预览 Block - 49: 源同步块,仅支持查询 - 50: 引用同步块,仅支持查询。获取引用同步块内容详见:如何获取引用同步块的内容 - 51: Wiki 新版子目录 - 52: AI 模板 Block,仅支持查询 - 999: 未支持 Block |
└ page | text | 文档的根 Block,也称页面 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ text | text | 文本 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading1 | text | 一级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading2 | text | 二级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading3 | text | 三级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading4 | text | 四级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading5 | text | 五级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading6 | text | 六级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading7 | text | 七级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading8 | text | 八级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ heading9 | text | 九级标题 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ bullet | text | 无序列表 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ ordered | text | 有序列表 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ code | text | 代码块 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ quote | text | 引用 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | text | 公式 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ todo | text | 待办事项 Block |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ bitable | bitable | 多维表格 Block |
└ token | string | 多维表格文档 Token |
└ callout | callout | 高亮块 Block |
└ background_color | int | 高亮块背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 中红色 - 9: 中橙色 - 10: 中黄色 - 11: 中绿色 - 12: 中蓝色 - 13: 中紫色 - 14: 灰色 - 15: 浅灰色 |
└ border_color | int | 边框色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ text_color | int | 文字颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ emoji_id | string | 高亮块图标 |
└ chat_card | chat_card | 群聊卡片 Block |
└ chat_id | string | 群聊天会话 ID。获取方式参考群 ID 说明 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ diagram | diagram | 流程图/UML Block |
└ diagram_type | int | 绘图类型 可选值有: - 1: 流程图 - 2: UML 图 |
└ divider | divider | 分割线 Block。为空结构体,需传入 {} 创建分割线 Block。 |
└ file | file | 文件 Block。了解如何在文档中插入文件,参考文档常见问题-如何插入文件/附件。 |
└ token | string | 附件 Token |
└ name | string | 文件名 |
└ view_type | int | 视图类型,卡片视图(默认)或预览视图 可选值有: - 1: 卡片视图 - 2: 预览视图 |
└ grid | grid | 分栏 Block |
└ column_size | int | 分栏列数量 |
└ grid_column | grid_column | 分栏列 Block |
└ width_ratio | int | 当前分栏列占整个分栏的比例,单位 % |
└ iframe | iframe | 内嵌 Block |
└ component | iframe_component | iframe 的组成元素 |
└ iframe_type | int | iframe 类型 可选值有: - 1: 哔哩哔哩 - 2: 西瓜视频 - 3: 优酷 - 4: Airtable - 5: 百度地图 - 6: 高德地图 - 7: Undefined - 8: Figma - 9: 墨刀 - 10: Canva - 11: CodePen - 12: 飞书问卷 - 13: 金数据 - 14: Undefined - 15: Undefined - 99: Other |
└ url | string | iframe 目标 url(需要进行 url_encode) |
└ image | image | 图片 Block。了解如何在文档中插入图片,参考文档常见问题-如何插入图片。 |
└ width | int | 宽度单位 px |
└ height | int | 高度单位 px |
└ token | string | 图片 Token |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ caption | caption | 图片描述 |
└ content | string | 描述的文本内容 |
└ isv | isv | 三方 Block |
└ component_id | string | 团队互动应用唯一ID。该 ID 可通过调用创建 BlockEntity 接口,并从响应体中的 block_id 中获取,创建时使用的 block_type_id 需要与 component_type_id 一致。 |
└ component_type_id | string | 团队互动应用类型,比如信息收集"blk_5f992038c64240015d280958"。该 ID 可在 开发者后台 > 应用详情页 > 应用能力 > 云文档小组件 > BlockTypeID 获取。 |
└ add_ons | add_ons | Add-ons |
└ component_id | string | 文档小组件 ID。该 ID 可通过调用创建 BlockEntity 接口,并从响应体中的 block_id 中获取,创建时使用的 block_type_id 需要与 component_type_id 一致。 |
└ component_type_id | string | 文档小组件类型,比如问答互动"blk_636a0a6657db8001c8df5488"。该 ID 可在 开发者后台 > 应用详情页 > 应用能力 > 云文档小组件 > BlockTypeID 获取。 |
└ record | string | 文档小组件内容数据,JSON 字符串 |
└ mindnote | mindnote | 思维笔记 Block |
└ token | string | 思维导图 token |
└ sheet | sheet | 电子表格 Block |
└ token | string | 电子表格 block 的 token 和工作表的 ID 的组合 |
└ table | table | 表格 Block |
└ cells | string\[\] | 单元格数组,数组元素为 Table Cell Block 的 ID |
└ property | table_property | 表格属性 |
└ row_size | int | 行数 - 创建块接口中,该字段最大值为 9 - 创建嵌套块接口中,在单个表格单元格不超过上限 2000 情况下,该字段无固定最大值 |
└ column_size | int | 列数 - 创建块接口中,该字段最大值为 9 - 创建嵌套块接口中,该字段最大值为 100 |
└ column_width | int\[\] | 列宽,单位像素(px) |
└ merge_info | table_merge_info\[\] | 单元格合并信息。创建 Table 时,此属性只读,将由系统自动生成。如果需要合并单元格,可以通过更新块接口的子请求 merge_table_cells 实现 |
└ row_span | int | 从当前行索引起被合并的连续行数 |
└ col_span | int | 从当前列索引起被合并的连续列数 |
└ header_row | boolean | 设置首行为标题行 |
└ header_column | boolean | 设置首列为标题列 |
└ table_cell | table_cell | 单元格 Block |
└ view | view | 视图 Block |
└ view_type | int | 视图类型 可选值有: - 1: 卡片视图 - 2: 预览视图 - 3: 内联视图 |
└ undefined | undefined | 未支持 Block |
└ quote_container | quote_container | 引用容器 Block。为空结构体,需传入 {} 创建引用容器 Block。 |
└ task | task | 任务 Block |
└ task_id | string | 任务 ID,查询具体任务详情见 获取任务详情 |
└ folded | boolean | 折叠状态 |
└ okr | okr | OKR Block,仅可在使用 user_access_token 时创建 |
└ okr_id | string | OKR ID,获取需要插入的 OKR ID 可见获取用户的 OKR 列表 |
└ period_display_status | string | 周期的状态 可选值有: - default: 默认 - normal: 正常 - invalid: 失效 - hidden: 隐藏 |
└ period_name_zh | string | 周期名 - 中文 |
└ period_name_en | string | 周期名 - 英文 |
└ user_id | string | OKR 所属的用户 ID |
└ visible_setting | okr_visible_setting | 可见性设置 |
└ progress_fill_area_visible | boolean | 进展编辑区域是否可见 |
└ progress_status_visible | boolean | 进展状态是否可见 |
└ score_visible | boolean | 分数是否可见 |
└ okr_objective | okr_objective | OKR Objective Block |
└ objective_id | string | Objective ID |
└ confidential | boolean | 是否在 OKR 平台设置了私密权限 |
└ position | int | Objective 的位置编号,对应 Block 中 O1、O2 的 1、2 |
└ score | int | 打分信息 |
└ visible | boolean | OKR Block 中是否展示该 Objective |
└ weight | float | Objective 的权重 |
└ progress_rate | okr_progress_rate | 进展信息 |
└ mode | string | 状态模式 可选值有: - simple: 简单模式 - advanced: 高级模式 |
└ current | float | 当前进度,单位 %,advanced 模式使用 |
└ percent | float | 当前进度百分比,simple 模式使用 |
└ progress_status | string | 进展状态 可选值有: - unset: 未设置 - normal: 正常 - risk: 有风险 - extended: 已延期 |
└ start | float | 进度起始值,单位 %,advanced 模式使用 |
└ status_type | string | 状态计算类型 可选值有: - default: 以风险最高的 Key Result 状态展示 - custom: 自定义 |
└ target | float | 进度目标值,单位 %,advanced 模式使用 |
└ content | text | Objective 的文本内容 |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ okr_key_result | okr_key_result | OKR Key Result |
└ kr_id | string | Key Result 的 ID |
└ confidential | boolean | 是否在 OKR 平台设置了私密权限 |
└ position | int | Key Result 的位置编号,对应 Block 中 KR1、KR2 的 1、2。 |
└ score | int | 打分信息 |
└ visible | boolean | OKR Block 中此 Key Result 是否可见 |
└ weight | float | Key Result 的权重 |
└ progress_rate | okr_progress_rate | 进展信息 |
└ mode | string | 状态模式 可选值有: - simple: 简单模式 - advanced: 高级模式 |
└ current | float | 当前进度,单位 %,advanced 模式使用 |
└ percent | float | 当前进度百分比,simple 模式使用 |
└ progress_status | string | 进展状态 可选值有: - unset: 未设置 - normal: 正常 - risk: 有风险 - extended: 已延期 |
└ start | float | 进度起始值,单位 %,advanced 模式使用 |
└ status_type | string | 状态计算类型 可选值有: - default: 以风险最高的 Key Result 状态展示 - custom: 自定义 |
└ target | float | 进度目标值,单位 %,advanced 模式使用 |
└ content | text | Key Result 的文本内容 |
└ style | text_style | 文本样式 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ done | boolean | todo 的完成状态。支持对 Todo 块进行修改 |
└ folded | boolean | 文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改 |
└ language | int | 代码块的语言类型。仅支持对 Code 块进行修改 可选值有: - 1: PlainText - 2: ABAP - 3: Ada - 4: Apache - 5: Apex - 6: Assembly Language - 7: Bash - 8: CSharp - 9: C++ - 10: C - 11: COBOL - 12: CSS - 13: CoffeeScript - 14: D - 15: Dart - 16: Delphi - 17: Django - 18: Dockerfile - 19: Erlang - 20: Fortran - 21: FoxPro - 22: Go - 23: Groovy - 24: HTML - 25: HTMLBars - 26: HTTP - 27: Haskell - 28: JSON - 29: Java - 30: JavaScript - 31: Julia - 32: Kotlin - 33: LateX - 34: Lisp - 35: Logo - 36: Lua - 37: MATLAB - 38: Makefile - 39: Markdown - 40: Nginx - 41: Objective-C - 42: OpenEdgeABL - 43: PHP - 44: Perl - 45: PostScript - 46: Power Shell - 47: Prolog - 48: ProtoBuf - 49: Python - 50: R - 51: RPG - 52: Ruby - 53: Rust - 54: SAS - 55: SCSS - 56: SQL - 57: Scala - 58: Scheme - 59: Scratch - 60: Shell - 61: Swift - 62: Thrift - 63: TypeScript - 64: VBScript - 65: Visual Basic - 66: XML - 67: YAML - 68: CMake - 69: Diff - 70: Gherkin - 71: GraphQL - 72: OpenGL Shading Language - 73: Properties - 74: Solidity - 75: TOML |
└ wrap | boolean | 代码块是否自动换行。支持对 Code 块进行修改 |
└ background_color | string | 块的背景色 可选值有: - LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色 |
└ indentation_level | string | 首行缩进级别。仅支持对 Text 块进行修改。 可选值有: - NoIndent: 无缩进 - OneLevelIndent: 一级缩进 |
└ sequence | string | 用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段 |
└ elements | text_element\[\] | 文本元素 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ okr_progress | okr_progress | OKR 进展信息 |
└ comment_ids | string\[\] | 评论 id 列表 |
└ jira_issue | jira_issue | Jira 问题 |
└ id | string | Jira 问题 ID |
└ key | string | Jira 问题 key |
└ wiki_catalog | wiki_catalog | Wiki 子目录 Block |
└ wiki_token | string | 知识库 token |
└ board | board | 画板 Block |
└ token | string | 画板 token |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ width | int | 宽度,单位 px;不填时自动适应文档宽度;值超出文档最大宽度时,页面渲染为文档最大宽度 |
└ height | int | 高度,单位 px;不填时自动根据画板内容计算;值超出屏幕两倍高度时,页面渲染为屏幕两倍高度 |
└ agenda | agenda | 议程 Block |
└ agenda_item | agenda_item | 议程项 Block |
└ agenda_item_title | agenda_item_title | 议程项标题 Block |
└ elements | agenda_title_element\[\] | 文本元素 |
└ text_run | text_run | 文字 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联附件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联 block |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ agenda_item_content | agenda_item_content | 议程项内容 Block |
└ link_preview | link_preview | 链接预览 Block |
└ url_type | string | 链接类型 可选值有: - MessageLink: 消息链接 - Undefined: 未定义的链接类型 |
└ source_synced | source_synced | 源同步块,仅支持查询 |
└ elements | text_element\[\] | 同步块独立页标题,由文本元素组成 |
└ text_run | text_run | 文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改 |
└ content | string | 文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_user | mention_user | @用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。 |
└ user_id | string | 用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ mention_doc | mention_doc | @文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ token | string | 云文档 token。获取方式参考如何获取云文档资源相关 token(id) |
└ obj_type | int | 云文档类型 可选值有: - 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx |
└ url | string | 云文档链接(需要 url_encode) |
└ title | string | 文档标题,只读属性 |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ reminder | reminder | 日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改 |
└ create_user_id | string | 创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。 |
└ is_notify | boolean | 是否通知 |
└ is_whole_day | boolean | 是日期还是整点小时 |
└ expire_time | string | 事件发生的时间(毫秒级时间戳) |
└ notify_time | string | 触发通知的时间(毫秒级时间戳) |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ file | inline_file | 内联文件。仅支持删除或移动位置,不支持创建新的内联文件 |
└ file_token | string | 附件 token |
└ source_block_id | string | 当前文档中该文件所处的 block 的 ID |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ undefined | undefined_element | 未支持的 TextElement |
└ inline_block | inline_block | 内联块。仅支持删除或移动位置,不支持创建新的内联块 |
└ block_id | string | 关联的内联状态的 block 的 block_id |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ equation | equation | 公式 |
└ content | string | 符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html |
└ text_element_style | text_element_style | 文本局部样式 |
└ bold | boolean | 加粗 |
└ italic | boolean | 斜体 |
└ strikethrough | boolean | 删除线 |
└ underline | boolean | 下划线 |
└ inline_code | boolean | inline 代码 |
└ background_color | int | 背景色 可选值有: - 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色 |
└ text_color | int | 字体颜色 可选值有: - 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色 |
└ link | link | 链接 |
└ url | string | 超链接指向的 url (需要 url_encode) |
└ comment_ids | string\[\] | 评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。 |
└ align | int | 对齐方式 可选值有: - 1: 居左排版 - 2: 居中排版 - 3: 居右排版 |
└ reference_synced | reference_synced | 引用同步块,仅支持查询。获取引用同步块内容详见:如何获取引用同步块的内容 |
└ source_document_id | string | 源文档的文档 ID |
└ source_block_id | string | 源同步块的 Block ID |
└ sub_page_list | sub_page_list | Wiki 新版子目录 |
└ wiki_token | string | 知识库节点 token,仅支持知识库文档创建子页面列表,且需传入当前页面的 wiki token |
└ ai_template | ai_template | AI 模板 Block,仅支持查询 |
响应体示例
json
{
"code": 0,
"data": {
"block": {
"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": {}
}
}
},
"msg": ""
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1770001 | invalid param | 确认传入的参数是否合法 |
| 404 | 1770002 | not found | 文档场景中: 文档的 document_id 不存在。请确认文档是否已被删除或 document_id 是否填写正确。参考文档概述了解如何获取文档的 document_id。 群公告场景中: 群 ID chat_id 不存在。请确认群是否被解散或 chat_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 版本(Revision_id)是否过旧。指定的版本号与文档最新版本号差值不能超过 1000 |
| 400 | 1770022 | invalid page token | 确认查询参数中的 page_token 是否合法 |
| 400 | 1770024 | invalid operation | 确认操作是否合法: - 除了 text_run,其他 text_element 不允许设置 link 属性 - 编辑请求中 text_element 中不允许设置 undefined 元素 - 分栏的列数范围在 [2, 10] 之间,不允许减少或者增加分栏列数超过约定范围 - 表格只有一行或者一列时,不允许通过减少表格行列的请求操作表格 |
| 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 | content size exceed limit | 纯文本内容大小超过 10485760 字符限制,请减少内容后重试。 |
| 400 | 1770034 | operation count exceed limited | 当前请求中涉及单元格个数过多,请拆分成多次请求 |
| 403 | 1770032 | forbidden | 文档场景中: 确认当前调用身份是否有文档阅读(获取相关接口)或编辑(更新、删除、创建相关接口)权限。请参考以下方式解决: - 如果你使用的是 tenant_access_token,意味着当前应用没有文档权限。你需通过云文档网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加文档权限。 说明:在 添加文档应用 前,你需确保目标应用至少开通了一个云文档或多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 如果你使用的是 user_access_token,意味着当前用户没有文档权限。你需通过云文档网页页面右上方 分享 入口为当前用户添加文档权限。 了解具体操作步骤或其它添加权限方式,参考云文档常见问题 3。 对于创建和更新相关接口,你还需要确认: - 当前调用身份是否有 MentionDoc 即 @文档 中文档的阅读权限 - MentionUser 即 @用户 中的用户是否在职且与当前调用身份互为联系人 - 当前调用身份是否具有群卡片的查看和分享权限 - 当前调用身份是否具有访问指定 Wiki 即知识库子目录的权限 - 当前调用身份是否具有 OKR、ISV、Add-Ons 等文档块的查看权限 群公告场景中: 当前的操作者没有群公告的编辑权限。解决方案: - 方案一:调用指定群管理员接口,将当前操作者置为群管理员,然后重试。 - 方案二:在 飞书客户端 > 群组 > 设置 > 群管理 中,将 谁可以编辑群信息 设置为 所有群成员,然后重试。 对于创建和更新相关接口,你还需要确认: - 当前调用身份是否有 MentionDoc 即 @文档 中文档的阅读权限 - MentionUser 即 @用户 中的用户是否在职且与当前调用身份互为联系人 - 当前调用身份是否具有群卡片的查看和分享权限 - 当前调用身份是否具有访问指定 Wiki 即知识库子目录的权限 - 当前调用身份是否具有 OKR、ISV、Add-Ons 等文档块的查看权限 |
| 500 | 1771001 | server internal error | 服务器内部错误。请重试,若仍无法解决请咨询技术支持。 |
| 500 | 1771006 | mount folder failed | 挂载文档到云空间文件夹失败。请检查是否错误地传入了 wiki_token 并重试。若仍无法解决请咨询技术支持。 |
| 500 | 1771002 | gateway server internal error | 网关服务内部错误。请重试,若仍无法解决请咨询技术支持。 |
| 500 | 1771003 | gateway marshal error | 网关服务解析错误。请重试,若仍无法解决请咨询技术支持。 |
| 500 | 1771004 | gateway unmarshal error | 网关服务反解析错误。请重试,若仍无法解决请咨询技术支持。 |
| 503 | 1771005 | system under maintenance | 系统服务正在维护中,请重试,若仍无法解决请咨询技术支持 |

- 如果你使用的是
了解具体操作步骤或其它添加权限方式,参考