Skip to content

获取所有子块

获取群公告中指定块的所有子块的富文本内容并分页返回。

Tip: 应用频率限制:单个应用调用频率上限为每秒 10 次,超过该频率限制,接口将返回 HTTP 状态码 400 及错误码 99991400。当请求被限频,应用需要处理限频状态码,并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。

前提条件

  • 应用需要开启机器人能力
  • 调用当前接口的用户或者机器人必须在对应的群组内。
  • 获取内部群信息时,调用当前接口的用户或者机器人必须与对应群组在同一租户下。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/docx/v1/chats/:chat_id/announcement/blocks/:block_id/children
HTTP MethodGET
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用im:chat.announcement:read 查看群公告信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
chat_idstring群 ID。获取方式:
- 创建群,从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口,可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
注意:单聊(群类型为 p2p)不支持获取群公告。
示例值:"oc_5ad11d72b830411d72b836c20"
block_idstringBlock 的唯一标识。你可通过调用获取群公告所有块接口获取块的 block_id。
示例值:"doxcnO6UW6wAw2qIcYf4hZpFIth"

查询参数

名称类型必填描述
revision_idint查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的更新权限。
示例值:-1
默认值-1
数据校验规则
- 最小值:-1
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:"aw7DoMKBFMOGwqHCrcO8w6jCmMOvw6ILeADCvsKNw57Di8O5XGV3LG4_w5HCqhFxSnDCrCzCn0BgZcOYUg85EMOYcEAcwqYOw4ojw5QFwofCu8KoIMO3K8Ktw4IuNMOBBHNYw4bCgCV3U1zDu8K-J8KSR8Kgw7Y0fsKZdsKvW3d9w53DnkHDrcO5bDkYwrvDisOEPcOtVFJ-I03CnsOILMOoAmLDknd6dsKqG1bClAjDuS3CvcOTwo7Dg8OrwovDsRdqIcKxw5HDohTDtXN9w5rCkWo"
page_sizeint分页大小
示例值:500
默认值500
数据校验规则
- 最小值:1
user_id_typestring用户 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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsblock\[\]Block 的 Children 列表
    └ block_idstring子块的唯一标识
    └ parent_idstring子块的父块 ID
    └ childrenstring\[\]子块的子块 ID 列表
    └ block_typeintBlock 类型
可选值有
- 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 - 999: 未支持 Block
    └ pagetext文档的根 Block,也称页面 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ texttext文本 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading1text一级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading2text二级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading3text三级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading4text四级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading5text五级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading6text六级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading7text七级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading8text八级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ heading9text九级标题 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ bullettext无序列表 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ orderedtext有序列表 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ codetext代码块 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ quotetext引用 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ equationtext公式 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ todotext待办事项 Block
      └ styletext_style文本样式
        └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
        └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
        └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
        └ languageint代码块的语言类型。仅支持对 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
        └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
        └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
        └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
        └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
      └ elementstext_element\[\]文本元素
        └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ bitablebitable多维表格 Block
      └ tokenstring多维表格文档 Token
    └ calloutcallout高亮块 Block
      └ background_colorint高亮块背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 中红色 - 9: 中橙色 - 10: 中黄色 - 11: 中绿色 - 12: 中蓝色 - 13: 中紫色 - 14: 灰色 - 15: 浅灰色
      └ border_colorint边框色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
      └ text_colorint文字颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
      └ emoji_idstring高亮块图标
    └ chat_cardchat_card群聊卡片 Block
      └ chat_idstring群聊天会话 ID。获取方式参考群 ID 说明
      └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
    └ diagramdiagram流程图/UML Block
      └ diagram_typeint绘图类型
可选值有
- 1: 流程图 - 2: UML 图
    └ dividerdivider分割线 Block。为空结构体,需传入 {} 创建分割线 Block。
    └ filefile文件 Block。了解如何在文档中插入文件,参考文档常见问题-如何插入文件/附件
      └ tokenstring附件 Token
      └ namestring文件名
      └ view_typeint视图类型,卡片视图(默认)或预览视图
可选值有
- 1: 卡片视图 - 2: 预览视图
    └ gridgrid分栏 Block
      └ column_sizeint分栏列数量
    └ grid_columngrid_column分栏列 Block
      └ width_ratioint当前分栏列占整个分栏的比例,单位 %
    └ iframeiframe内嵌 Block
      └ componentiframe_componentiframe 的组成元素
        └ iframe_typeintiframe 类型
可选值有
- 1: 哔哩哔哩 - 2: 西瓜视频 - 3: 优酷 - 4: Airtable - 5: 百度地图 - 6: 高德地图 - 7: Undefined - 8: Figma - 9: 墨刀 - 10: Canva - 11: CodePen - 12: 飞书问卷 - 13: 金数据 - 14: Undefined - 15: Undefined - 99: Other
        └ urlstringiframe 目标 url(需要进行 url_encode)
    └ imageimage图片 Block。了解如何在文档中插入图片,参考文档常见问题-如何插入图片
      └ widthint宽度单位 px
      └ heightint高度单位 px
      └ tokenstring图片 Token
      └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
    └ isvisv三方 Block
      └ component_idstring团队互动应用唯一ID。该 ID 可通过调用创建 BlockEntity 接口,并从响应体中的 block_id 中获取,创建时使用的 block_type_id 需要与 component_type_id 一致。
      └ component_type_idstring团队互动应用类型,比如信息收集"blk_5f992038c64240015d280958"。该 ID 可在 开发者后台 > 应用详情页 > 应用能力 > 云文档小组件 > BlockTypeID 获取。
    └ add_onsadd_onsAdd-ons
      └ component_idstring文档小组件 ID。该 ID 可通过调用创建 BlockEntity 接口,并从响应体中的 block_id 中获取,创建时使用的 block_type_id 需要与 component_type_id 一致。
      └ component_type_idstring文档小组件类型,比如问答互动"blk_636a0a6657db8001c8df5488"。该 ID 可在 开发者后台 > 应用详情页 > 应用能力 > 云文档小组件 > BlockTypeID 获取。
      └ recordstring文档小组件内容数据,JSON 字符串
    └ mindnotemindnote思维笔记 Block
      └ tokenstring思维导图 token
    └ sheetsheet电子表格 Block
      └ tokenstring电子表格 block 的 token 和工作表的 ID 的组合
    └ tabletable表格 Block
      └ cellsstring\[\]单元格数组,数组元素为 Table Cell Block 的 ID
      └ propertytable_property表格属性
        └ row_sizeint行数 - 创建块接口中,该字段最大值为 9 - 创建嵌套块接口中,在单个表格单元格不超过上限 2000 情况下,该字段无固定最大值
        └ column_sizeint列数 - 创建块接口中,该字段最大值为 9 - 创建嵌套块接口中,该字段最大值为 100
        └ column_widthint\[\]列宽,单位像素(px)
        └ merge_infotable_merge_info\[\]单元格合并信息。创建 Table 时,此属性只读,将由系统自动生成。如果需要合并单元格,可以通过更新块接口的子请求 merge_table_cells 实现
          └ row_spanint从当前行索引起被合并的连续行数
          └ col_spanint从当前列索引起被合并的连续列数
        └ header_rowboolean设置首行为标题行
        └ header_columnboolean设置首列为标题列
    └ table_celltable_cell单元格 Block
    └ viewview视图 Block
      └ view_typeint视图类型
可选值有
- 1: 卡片视图 - 2: 预览视图 - 3: 内联视图
    └ undefinedundefined未支持 Block
    └ quote_containerquote_container引用容器 Block。为空结构体,需传入 {} 创建引用容器 Block。
    └ tasktask任务 Block
      └ task_idstring任务 ID,查询具体任务详情见 获取任务详情
      └ foldedboolean折叠状态
    └ okrokrOKR Block,仅可在使用 user_access_token 时创建
      └ okr_idstringOKR ID,获取需要插入的 OKR ID 可见获取用户的 OKR 列表
      └ period_display_statusstring周期的状态
可选值有
- default: 默认 - normal: 正常 - invalid: 失效 - hidden: 隐藏
      └ period_name_zhstring周期名 - 中文
      └ period_name_enstring周期名 - 英文
      └ user_idstringOKR 所属的用户 ID
      └ visible_settingokr_visible_setting可见性设置
        └ progress_fill_area_visibleboolean进展编辑区域是否可见
        └ progress_status_visibleboolean进展状态是否可见
        └ score_visibleboolean分数是否可见
    └ okr_objectiveokr_objectiveOKR Objective Block
      └ objective_idstringObjective ID
      └ confidentialboolean是否在 OKR 平台设置了私密权限
      └ positionintObjective 的位置编号,对应 Block 中 O1、O2 的 1、2
      └ scoreint打分信息
      └ visiblebooleanOKR Block 中是否展示该 Objective
      └ weightfloatObjective 的权重
      └ progress_rateokr_progress_rate进展信息
        └ modestring状态模式
可选值有
- simple: 简单模式 - advanced: 高级模式
        └ currentfloat当前进度,单位 %,advanced 模式使用
        └ percentfloat当前进度百分比,simple 模式使用
        └ progress_statusstring进展状态
可选值有
- unset: 未设置 - normal: 正常 - risk: 有风险 - extended: 已延期
        └ startfloat进度起始值,单位 %,advanced 模式使用
        └ status_typestring状态计算类型
可选值有
- default: 以风险最高的 Key Result 状态展示 - custom: 自定义
        └ targetfloat进度目标值,单位 %,advanced 模式使用
      └ contenttextObjective 的文本内容
        └ styletext_style文本样式
          └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
          └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
          └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
          └ languageint代码块的语言类型。仅支持对 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
          └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
          └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
          └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
          └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
        └ elementstext_element\[\]文本元素
          └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
            └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
            └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
            └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
            └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
            └ urlstring云文档链接(需要 url_encode)
            └ titlestring文档标题,只读属性
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
            └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
            └ is_notifyboolean是否通知
            └ is_whole_dayboolean是日期还是整点小时
            └ expire_timestring事件发生的时间(毫秒级时间戳)
            └ notify_timestring触发通知的时间(毫秒级时间戳)
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
            └ file_tokenstring附件 token
            └ source_block_idstring当前文档中该文件所处的 block 的 ID
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ undefinedundefined_element未支持的 TextElement
          └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
            └ block_idstring关联的内联状态的 block 的 block_id
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ equationequation公式
            └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ okr_key_resultokr_key_resultOKR Key Result
      └ kr_idstringKey Result 的 ID
      └ confidentialboolean是否在 OKR 平台设置了私密权限
      └ positionintKey Result 的位置编号,对应 Block 中 KR1、KR2 的 1、2。
      └ scoreint打分信息
      └ visiblebooleanOKR Block 中此 Key Result 是否可见
      └ weightfloatKey Result 的权重
      └ progress_rateokr_progress_rate进展信息
        └ modestring状态模式
可选值有
- simple: 简单模式 - advanced: 高级模式
        └ currentfloat当前进度,单位 %,advanced 模式使用
        └ percentfloat当前进度百分比,simple 模式使用
        └ progress_statusstring进展状态
可选值有
- unset: 未设置 - normal: 正常 - risk: 有风险 - extended: 已延期
        └ startfloat进度起始值,单位 %,advanced 模式使用
        └ status_typestring状态计算类型
可选值有
- default: 以风险最高的 Key Result 状态展示 - custom: 自定义
        └ targetfloat进度目标值,单位 %,advanced 模式使用
      └ contenttextKey Result 的文本内容
        └ styletext_style文本样式
          └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
          └ donebooleantodo 的完成状态。支持对 Todo 块进行修改
          └ foldedboolean文本的折叠状态。支持对 Heading1~9、和有子块的 Text、Ordered、Bullet 和 Todo 块进行修改
          └ languageint代码块的语言类型。仅支持对 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
          └ wrapboolean代码块是否自动换行。支持对 Code 块进行修改
          └ background_colorstring块的背景色
可选值有
- LightGrayBackground: 浅灰色 - LightRedBackground: 浅红色 - LightOrangeBackground: 浅橙色 - LightYellowBackground: 浅黄色 - LightGreenBackground: 浅绿色 - LightBlueBackground: 浅蓝色 - LightPurpleBackground: 浅紫色 - PaleGrayBackground: 中灰色 - DarkGrayBackground: 灰色 - DarkRedBackground: 中红色 - DarkOrangeBackground: 中橙色 - DarkYellowBackground: 中黄色 - DarkGreenBackground: 中绿色 - DarkBlueBackground: 中蓝色 - DarkPurpleBackground: 中紫色
          └ indentation_levelstring首行缩进级别。仅支持对 Text 块进行修改。
可选值有
- NoIndent: 无缩进 - OneLevelIndent: 一级缩进
          └ sequencestring用于确定有序列表项编号,为具体数值或'auto' - 开始新列表时,有序列表编号从 1 开始,sequence='1' - 手动修改为非连续编号时,有序列表编号为设定的具体数值,如 sequence='3' - 继续编号时,有序列表编号自动连续,sequence='auto' - 部分历史数据和通过 OpenAPI 创建的有序列表不返回此字段
        └ elementstext_element\[\]文本元素
          └ text_runtext_run文字。支持对 Page、Text、Heading1~9、Bullet、Ordered、Code、Quote、Todo 块进行修改
            └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ mention_usermention_user@用户。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改。
            └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ mention_docmention_doc@文档。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
            └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
            └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
            └ urlstring云文档链接(需要 url_encode)
            └ titlestring文档标题,只读属性
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ reminderreminder日期提醒。支持对 Text、Heading1~9、Bullet、Ordered、Quote、Todo 块进行修改
            └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
            └ is_notifyboolean是否通知
            └ is_whole_dayboolean是日期还是整点小时
            └ expire_timestring事件发生的时间(毫秒级时间戳)
            └ notify_timestring触发通知的时间(毫秒级时间戳)
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ fileinline_file内联文件。仅支持删除或移动位置,不支持创建新的内联文件
            └ file_tokenstring附件 token
            └ source_block_idstring当前文档中该文件所处的 block 的 ID
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ undefinedundefined_element未支持的 TextElement
          └ inline_blockinline_block内联块。仅支持删除或移动位置,不支持创建新的内联块
            └ block_idstring关联的内联状态的 block 的 block_id
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
          └ equationequation公式
            └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
            └ text_element_styletext_element_style文本局部样式
              └ boldboolean加粗
              └ italicboolean斜体
              └ strikethroughboolean删除线
              └ underlineboolean下划线
              └ inline_codebooleaninline 代码
              └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
              └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
              └ linklink链接
                └ urlstring超链接指向的 url (需要 url_encode)
              └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
    └ okr_progressokr_progressOKR 进展信息
    └ comment_idsstring\[\]评论 id 列表
    └ jira_issuejira_issueJira 问题
      └ idstringJira 问题 ID
      └ keystringJira 问题 key
    └ wiki_catalogwiki_catalogWiki 子目录 Block
      └ wiki_tokenstring知识库 token
    └ boardboard画板 Block
      └ tokenstring画板 token
      └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
      └ widthint宽度,单位 px;不填时自动适应文档宽度;值超出文档最大宽度时,页面渲染为文档最大宽度
      └ heightint高度,单位 px;不填时自动根据画板内容计算;值超出屏幕两倍高度时,页面渲染为屏幕两倍高度
    └ agendaagenda议程 Block
    └ agenda_itemagenda_item议程项 Block
    └ agenda_item_titleagenda_item_title议程项标题 Block
      └ elementsagenda_title_element\[\]文本元素
        └ text_runtext_run文字
          └ contentstring文本内容。要实现文本内容的换行,你可以: - 在传入的文本内容中添加 \n 实现软换行(Soft Break,与在文档中通过操作 Shift + Enter 的效果一致) - 创建一个新的文本 Block,实现两个文本 Block 之间的硬换行(Hard Break,与在文档中通过操作 Enter 的效果一致)
注意:软换行在渲染时可能会被忽略,具体取决于渲染器如何处理;硬换行在渲染时始终会显示为一个新行。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_usermention_user@用户
          └ user_idstring用户 OpenID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ mention_docmention_doc@文档
          └ tokenstring云文档 token。获取方式参考如何获取云文档资源相关 token(id)
          └ obj_typeint云文档类型
可选值有
- 1: Doc - 3: Sheet - 8: Bitable - 11: MindNote - 12: File - 15: Slide - 16: Wiki - 22: Docx
          └ urlstring云文档链接(需要 url_encode)
          └ titlestring文档标题,只读属性
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ reminderreminder日期提醒
          └ create_user_idstring创建者用户 ID,ID 类型与查询参数 user_id_type 的取值一致。获取方式参考 user_id_type 参数说明。
          └ is_notifyboolean是否通知
          └ is_whole_dayboolean是日期还是整点小时
          └ expire_timestring事件发生的时间(毫秒级时间戳)
          └ notify_timestring触发通知的时间(毫秒级时间戳)
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ fileinline_file内联附件
          └ file_tokenstring附件 token
          └ source_block_idstring当前文档中该文件所处的 block 的 ID
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ undefinedundefined_element未支持的 TextElement
        └ inline_blockinline_block内联 block
          └ block_idstring关联的内联状态的 block 的 block_id
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
        └ equationequation公式
          └ contentstring符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html
          └ text_element_styletext_element_style文本局部样式
            └ boldboolean加粗
            └ italicboolean斜体
            └ strikethroughboolean删除线
            └ underlineboolean下划线
            └ inline_codebooleaninline 代码
            └ background_colorint背景色
可选值有
- 1: 浅红色 - 2: 浅橙色 - 3: 浅黄色 - 4: 浅绿色 - 5: 浅蓝色 - 6: 浅紫色 - 7: 中灰色 - 8: 红色 - 9: 橙色 - 10: 黄色 - 11: 绿色 - 12: 蓝色 - 13: 紫色 - 14: 灰色 - 15: 浅灰色
            └ text_colorint字体颜色
可选值有
- 1: 红色 - 2: 橙色 - 3: 黄色 - 4: 绿色 - 5: 蓝色 - 6: 紫色 - 7: 灰色
            └ linklink链接
              └ urlstring超链接指向的 url (需要 url_encode)
            └ comment_idsstring\[\]评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「获取回复」 API。
      └ alignint对齐方式
可选值有
- 1: 居左排版 - 2: 居中排版 - 3: 居右排版
    └ agenda_item_contentagenda_item_content议程项内容 Block
    └ link_previewlink_preview链接预览 Block
      └ url_typestring链接类型
可选值有
- MessageLink: 消息链接 - Undefined: 未定义的链接类型
  └ page_tokenstring下一个分页的分页标记
  └ has_moreboolean是否还有下一个分页

响应体示例

json
{
  "code": 0,
  "data": {
    "has_more": false,
    "items": [
      {
        "block_id": "EJ8pdBT6RoA2BtxKXfuc1TD0n8f",
        "block_type": 3,
        "heading1": {
          "elements": [
            {
              "text_run": {
                "content": "新版群公告",
                "text_element_style": {
                  "bold": false,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            }
          ],
          "style": {
            "align": 1,
            "folded": false
          }
        },
        "parent_id": "oc_5ad11d72b830411d72b836c20"
      },
      {
        "block_id": "WoF4dolv0ohvegxctR9c1t0sn4b",
        "block_type": 2,
        "parent_id": "oc_5ad11d72b830411d72b836c20",
        "text": {
          "elements": [
            {
              "text_run": {
                "content": "当你需要向群内所有成员传达",
                "text_element_style": {
                  "bold": false,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            },
            {
              "text_run": {
                "content": "重要信息",
                "text_element_style": {
                  "bold": true,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            },
            {
              "text_run": {
                "content": "时,可以使用群公告功能。后续入群的成员也可看到当前群公告。",
                "text_element_style": {
                  "bold": false,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            }
          ],
          "style": {
            "align": 1,
            "folded": false
          }
        }
      },
      {
        "block_id": "UPD7dhkrLo8ZCfxoAYLcuEbDnzd",
        "block_type": 2,
        "parent_id": "oc_5ad11d72b830411d72b836c20",
        "text": {
          "elements": [
            {
              "text_run": {
                "content": "群公告编辑",
                "text_element_style": {
                  "bold": false,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            },
            {
              "text_run": {
                "content": "支持实时保存及多人协作",
                "text_element_style": {
                  "background_color": 4,
                  "bold": false,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            },
            {
              "text_run": {
                "content": ",群成员",
                "text_element_style": {
                  "bold": false,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            },
            {
              "text_run": {
                "content": "可实时查看最新群公告内容。",
                "text_element_style": {
                  "background_color": 4,
                  "bold": false,
                  "inline_code": false,
                  "italic": false,
                  "strikethrough": false,
                  "underline": false
                }
              }
            }
          ],
          "style": {
            "align": 1,
            "folded": false
          }
        }
      }
    ]
  },
  "msg": "success"
}

错误码

HTTP状态码错误码描述排查建议
4001770001invalid param确认传入的参数是否合法
4041770002not found文档场景中: 文档的 document_id 不存在。请确认文档是否已被删除或 document_id 是否填写正确。参考文档概述了解如何获取文档的 document_id群公告场景中: 群 ID chat_id 不存在。请确认群是否被解散或 chat_id 是否填写正确。
4001772001Chat announcement can NOT be found in chat information.群公告信息异常。请重试,若仍无法解决请咨询技术支持
4001772002Operator and chat can NOT be in different tenants.操作内部群时,操作者和被操作的群组必须在同一租户下。请检查当前调用身份是否和群组属于同一租户。
4001772003Operator can NOT be out of the chat.操作者不在群组中。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
4001772004The operator or invited bots does NOT have the authority to manage external chats without the scope.当前被操作的群为外部群,暂不支持操作外部群。
4001772025Bot ability is not activated.应用未启用机器人能力。你需要登录开发者后台,在应用详情页的 应用能力 > 添加应用能力 页面内,添加 机器人 能力,并发布应用使配置生效。具体操作参见机器人能力
4001772006announcement type is not supported除「获取群公告基本信息」接口,其它新版群公告接口均无法操作 doc 类型的群公告,如需操作 doc 类型群公告请参考「旧版群公告」接口。
4001772034The app is unavailable or inactivated by the tenant.应用在本租户下未安装或未启用。需要先安装应用,再使用应用调用接口。
4031770032forbidden文档场景中: 确认当前调用身份是否有文档阅读(获取相关接口)或编辑(更新、删除、创建相关接口)权限。请参考以下方式解决: - 如果你使用的是 tenant_access_token,意味着当前应用没有文档权限。你需通过云文档网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加文档权限。 说明:在 添加文档应用 前,你需确保目标应用至少开通了一个云文档或多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 如果你使用的是 user_access_token,意味着当前用户没有文档权限。你需通过云文档网页页面右上方 分享 入口为当前用户添加文档权限。 image.png 了解具体操作步骤或其它添加权限方式,参考云文档常见问题 3。 对于创建和更新相关接口,你还需要确认: - 当前调用身份是否有 MentionDoc 即 @文档 中文档的阅读权限 - MentionUser 即 @用户 中的用户是否在职且与当前调用身份互为联系人 - 当前调用身份是否具有群卡片的查看和分享权限 - 当前调用身份是否具有访问指定 Wiki 即知识库子目录的权限 - 当前调用身份是否具有 OKR、ISV、Add-Ons 等文档块的查看权限 群公告场景中: 当前的操作者没有群公告的编辑权限。解决方案: - 方案一:调用指定群管理员接口,将当前操作者置为群管理员,然后重试。 - 方案二:在 飞书客户端 > 群组 > 设置 > 群管理 中,将 谁可以编辑群信息 设置为 所有群成员,然后重试。 对于创建和更新相关接口,你还需要确认: - 当前调用身份是否有 MentionDoc 即 @文档 中文档的阅读权限 - MentionUser 即 @用户 中的用户是否在职且与当前调用身份互为联系人 - 当前调用身份是否具有群卡片的查看和分享权限 - 当前调用身份是否具有访问指定 Wiki 即知识库子目录的权限 - 当前调用身份是否具有 OKR、ISV、Add-Ons 等文档块的查看权限
5001771001server internal error服务器内部错误。请重试,若仍无法解决请咨询技术支持
5001771002gateway server internal error网关服务内部错误。请重试,若仍无法解决请咨询技术支持
5001771003gateway marshal error网关服务解析错误。请重试,若仍无法解决请咨询技术支持
5001771004gateway unmarshal error网关服务反解析错误。请重试,若仍无法解决请咨询技术支持
5031771005system under maintenance系统服务正在维护中,请重试,若仍无法解决请咨询技术支持

内容来源:飞书开放平台 · 自动爬取整理