描述一篇文档的富文本内容，由标题和正文两部分组成。富文本内容获取

{
    "title": {object(Paragraph)}, 
    "body": {object(Body)}
}

字段说明 :

字段	类型	说明
title	object	文档标题
body	object	正文部分

Location

描述文档内各元素的位置

{
    "zoneId": string,
    "startIndex": int, 
    "endIndex": int
}

字段说明 :

字段	类型	说明
zoneId	string	编辑区域标识正文是 "0" 表格单元格是类似 "xr1m4jw7egd9nefz1s0mdsetenl5fbe3lygxc1azupv81i5t2rjmosw5ta0esuwtn8ksya" 的字符串
startIndex	int	元素起始位置偏移量，从 0 开始，范围区间 [0, EOF)
endIndex	int	元素结束位置偏移量，范围区间 [0, EOF)

Title

文档的标题。仅支持纯文本和对齐方式。

字段说明 :

字段	说明
paragraph.style	只支持align属性
paragraph.elements	只支持textRun，传入的 textStyle 会被丢弃

Body

文档的正文部分，由 Block 组成。

{
    "blocks": [{object(Block)}]
}

字段说明 :

字段	类型	说明
blocks	[]object	文档结构是按行排列的，每行内容是一个 Block，详见文档数据结构概述

Block

文档的一行内容的基本元素。

{
    "type": string,
    "paragraph": {object(Paragraph)},
    "horizontalLine": {object(HorizontalLine)},
    "embeddedPage": {object(EmbeddedPage)},
    "chatGroup": {object(ChatGroup)},
    "table": {object(Table)},
    "sheet": {object(Sheet)},
    "bitable": {object(Bitable)},
    "gallery": {object(Gallery)},
    "file": {object(File)},
    "diagram": {object(Diagram)},
    "jira": {object(Jira)},
    "poll": {object(Poll)},
    "code": {object(Code)},
    "docsApp": {object(DocsApp)},
    "callout": {object(Callout)},
    "undefinedBlock": {object{UndefinedBlock}}
}

字段说明 :

字段	类型	说明
type	string	由下列类型组成，每个 Block 可以指定一种类型
paragraph	object	文本段落
gallery	object	图片
file	object	文件上传
chatGroup	object	群名片
table	object	格式化表格
horizontalLine	object	水平分割线
embeddedPage	object	内嵌网页，例如西瓜视频等
sheet	object	电子表格
bitable	object	数据表或看板
diagram	object	绘图或uml图
jira	object	jira filter或jira issue
poll	object	投票
code	object	新代码块
docsApp	object	团队互动应用
callout	object	高亮块
undefinedBlock	object	未支持的block，全部用undefineBlock表示

Paragraph

一行文本段落，可以由多个行内元素组成。

{
    "style": object (ParagraphStyle),
    "elements":  [{object (ParagraphElement)}],
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
style	object	段落样式
elements	[]object	段落元素组成一个段落
location	Location	元素位置。仅返回，不支持写入

ParagraphStyle

一行文本段落的样式，支持定义段落标题、列表、引用、行对齐方式。

{
    "headingLevel": int,
    "collapse": bool,
    "list": {object (List)},
    "quote": bool,
    "align": string
}

字段说明 :

字段	类型	说明
headingLevel	int	标题级别，支持 1-9 级标题，取值范围：[1,9]
collapse	bool	标题是否折叠，仅headingLevel为[1,9]时有效
list	object	有序列表/无序列表/任务列表/旧版代码块
quote	bool	引用样式
align	string	行对齐方式左对齐（默认）：left 右对齐：right 居中对齐：center

List

列表段落，包括有序、无序列表，任务列表，旧版代码块。
注意如需插入代码块，请使用 Block.Code，Paragraph.List.Code 即将下线。

{
    "type": string,
    "indentLevel": int,
    "number": int
}

字段说明 :

字段	类型	说明
type	string	有序列表：number 无序列表：bullet 任务列表：checkBox 已完成的任务列表：checkedBox 旧版代码块：code
indentLevel	int	列表的缩进级别，支持指定一行的缩进除代码块以外的列表都支持设置缩进，支持 1-16 级缩进，取值范围：[1,16]
number	Int	用于指定列表的行号，仅对有序列表和代码块生效如果为有序列表设置了缩进，行号可能会显示为字母或者罗马数字

ParagraphElement

组成段落的行内元素，一行可以包含多个行内元素。

{
    "type": string,
    "textRun": {object(TextRun)},
    "docsLink": {object(DocsLink)},
    "person": {object(Person)},
    "equation": {object(Equation)},
    "reminder": {object(Reminder)},
    "file": {object(File)},
    "jira": {object(Jira)},
    "undefinedElement": {object(UndefinedElement)}
}

字段说明 :

字段	类型	说明
type	string	由下列类型组成，每个元素可以指定一种类型
textRun	object	文本
docsLink	object	文档链接，可以根据链接自动识别为标题
person	object	@用户
equation	object	LaTeX 公式
reminder	object	任务列表截止时间，当且仅当这行是 checkBox 类型时才会生效
file	object	文件的行内展示样式，会展示文件的名称
jira	object	行内的jira issue
undefinedElement	object	暂未支持的行内元素，不支持写入

TextRun

段落中的文本内容。

{
    "text": string,
    "style": {object(TextStyle)},
    "lineId": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
text	string	具体的文本内容
style	object	文本内容的样式，支持 BIUS、颜色等
lineId	string	仅返回，不支持写入。对于段落样式为 Heading 的，可以通过 lineId 拼接出段落的跳转链接
location	Location	仅返回，不支持写入。描述元素在当前区域（由 zoneId 指定）的位置

TextStyle

文本样式。

{
    "bold": bool,
    "italic": bool,
    "strikeThrough": bool,
    "underLine": bool,
    "codeInline": bool,
    "backColor": {object(RGBColor)},
    "textColor": {object(RGBColor)},
    "link": {object(Link)}
}

字段说明 :

字段	类型	说明
bold	bool	加粗
italic	bool	斜体
strikeThrough	bool	删除线
underLine	bool	下划
codeInline	bool	行内代码样式
backColor	object	背景色
textColor	object	字体颜色
link	object	超链接

RGBColor

支持为文本指定颜色，会根据线上文本支持的颜色进行校验，不支持色板以外的颜色。

{
    "red": int,
    "green": int,
    "blue": int,
    "alpha": float
}

字段说明 :

字段	类型	说明
red	int	取值范围：[0,255]
green	int	取值范围：[0,255]
blue	int	取值范围：[0,255]
alpha	float	取值范围：[0,1]

颜色校验：

支持的字体颜色：rgb(216, 57, 49), rgb(222, 120, 2), rgb(220, 155, 4), rgb(46, 161, 33), rgb(36, 91, 219), rgb(36, 91, 219), rgb(100, 37, 208), rgb(143, 149, 158)
支持的背景颜色：rgb(251, 191, 188), rgb(254, 212, 164), rgb(255, 246, 122), rgb(183, 237, 177), rgb(186, 206, 253), rgb(205, 178, 250), rgb(222, 224, 227), rgb(247, 105, 100), rgb(255, 165, 61), rgb(255, 233, 40), rgb(98, 210, 86), rgb(78, 131, 253), rgb(147, 90, 246), rgb(187, 191, 196)

Link

超链接。

{
    "url": string
}

字段说明 :

字段	类型	说明
url	string	超链接的地址，读写都必须使用query escape编码。比如https%3A%2F%2Fwww.baidu.com%2Fmaps%2Fembed%2Fv1%2Fplace%3Fkey%3DAIzaSyAfJZc8JxNRe909WC_QBILdlM55NqGnI30%26q%3DCentral%2BPark%26center%3D40.7828647%2C-73.9675438%26zoom%3D17z%26language%3Den

DocsLink

文档链接，需要传入云文档的链接，支持所有云文档类型。有效链接示例：https://sample.feishu.cn/docs/doccnByZP6puODElAYySJkPIfUb

{
    "url": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
url	string	云文档链接
location	Location	元素位置。仅返回，不支持写入

Person

{
    "openId": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
openId	string	用户的 openId，比如ou_3bbe8a09c20e89cce9bff989ed840674。
location	Location	元素位置。仅返回，不支持写入

Reminder

日期提醒，当且仅当所在行样式是 checkBox 时有效。

{
    "isWholeDay": bool,
    "timestamp": int,
    "shouldNotify": bool,
    "notifyType": int,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
isWholeDay	bool	日期还是整点小时
timestamp	int	如果设置时间，要求30分或整点；如果不设置IsWholeDay true，时间戳为H:59:59，H和时区相关
shouldNotify	bool	是否通知
notifyType	int	通知触发时机isWholeDay 为false时： 0 现在1 提前5分钟2 提前15分钟3 提前30分钟4 提前1小时5 提前2小时6 提前1天7 提前2天isWholeDay 为true时：50 当天9点51 提前一天9点52 提前两天9点53 提前一周9点
location	Location	元素位置。仅返回，不支持写入

Equation

LaTeX 公式。

{
    "equation": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
equation	string	LaTeX 公式，需要遵循 LaTeX 的语法，比如"E=mc^2"
location	Location	元素位置。仅返回，不支持写入

UndefinedElement

未支持的行内元素

{
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
location	Location	元素位置。仅返回，不支持写入

Gallery

图片。

{
    "galleryStyle": {object(GalleryStyle)},
    "imageList": [{object(ImageItem)}],
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
galleryStyle	GalleryStyle	图片样式，目前仅支持指定对齐方式
imageList	[]ImageItem	图片对象，如果同时传入多张，会显示为同行多图。一行内最多显示 6 张图片
location	Location	元素位置。仅返回，不支持写入

GalleryStyle

图片样式，目前仅支持指定对齐方式。

{
    "align": string
}

字段说明 :

字段	类型	说明
align	string	图片对齐方式，仅当一行内只有一张图片时生效。居中（默认）：center 左对齐：left 右对齐：right

ImageItem

单次写操作图片和附件最多 50 个，单个图片最大 20M。本地图片需要先通过上传素材或分片上传素材进行上传，支持jpg、jpeg、bmp、png 和 gif 格式。

字段说明 :

字段	类型	说明
fileToken	string	图片 token，比如boxcnOj88GDkmWGm2zsTyCBqoLb，不支持编辑
width	float	图片宽，单位px
height	float	图片高，单位px

支持指定图片宽高，为了保证图片显示效果，会根据图片原始宽高比例进行校验计算，最终的显示效果可能与手动指定的宽高有一定区别。

File

单次写操作图片和附件最多 50 个。本地文件需要先通过上传素材或分片上传素材进行上传。

{
    "fileToken": string,
    "viewType": string,
    "fileName": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
fileToken	string	附件 token，比如boxcnOj88GDkmWGm2zsTyCBqoLb，不支持编辑
viewType	string	文件展示样式。预览：preview 卡片：card 行内：inline
fileName	string	文件名，不支持编辑
location	Location	元素位置。仅返回，不支持写入

HorizontalLine

水平分割线。

{
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
location	Location	元素位置。仅返回，不支持写入

EmbeddedPage

内嵌的网页。

{
    "type": string,
    "url" : string,
    "width": float,
    "height": float,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
type	string	支持以下网页： bilibili："bilibili" 西瓜视频："xigua" 优酷："youku" Airtable："airtable" 百度地图："baidumap"
url	string	第三方网页链接，读写都必须使用query escape编码。比如https%3A%2F%2Fwww.baidu.com%2Fmaps%2Fembed%2Fv1%2Fplace%3Fkey%3DAIzaSyAfJZc8JxNRe909WC_QBILdlM55NqGnI30%26q%3DCentral%2BPark%26center%3D40.7828647%2C-73.9675438%26zoom%3D17z%26language%3Den
width	float	窗口宽度，如未指定使用默认值，如果提供会使用默认宽高等比计算高度
height	float	窗口高度，如未指定使用默认值
location	Location	元素位置。仅返回，不支持写入

ChatGroup

{
    "openChatId": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
openChatId	string	群聊天会话openId，比如oc_4149593da6ef5fe4de16b10cb4769c94 文档拷贝副本后，对于没有权限的群名片会替换为"none" 对于写操作，如果使用"none"或者用户不在该群都会返回无权限错误
location	Location	元素位置。仅返回，不支持写入

Table

文档内普通表格，如要了解文档内的数据表格或多维表格，请查看下方 Sheet、Bitable 部分。

创建支持两种方式，二选一：

提供rowSize、columnSize、tableRows、tableStyle、mergedCells 带内容创建

指定rowSize和columnSize创建空表格

{    
    "tableId": string,
    "rowSize": int,
    "columnSize": int,
    "tableRows": [{object(TableRow)}],
    "tableStyle": {object(TableStyle)},
    "mergedCells": [{object(MergedCell)}],
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
tableId	string	表格ID，不可编辑
rowSize	int	表格行数量，创建空表格时最大值 9
columnSize	int	表格列数量，创建空表格时最大值 9
tableRows	[]object	表格行内容，带内容创建时必须和 rowSize、columnSize 一致
tableStyle	object	表格样式
mergedCells	[]object	合并单元格信息
location	Location	元素位置。仅返回，不支持写入

TableRow

普通表格的一行。

{
    "rowIndex": int,
    "tableCells":[{object(TableCell)}]
}

字段说明 :

字段	类型	说明
rowIndex	int	行索引，从 0 开始，第一行是 0，不可编辑
tableCells	[]object	表格单元格内容

TableCell

普通表格的一个单元格。

{
    "columnIndex": int,
    "zoneId": string,
    "body": {object(Body)}
}

字段说明 :

字段	类型	说明
columnIndex	int	列索引，从 0 开始，第一列是 0，不可编辑
zoneId	string	单元格ID
body	object	单元格内容，支持 Table、Sheet、Bitable 以外的 Block

TableStyle

表格样式，目前仅支持调整表格的列宽。

{
    "tableColumnProperties": [{object(TableColumnProperties)}]
}

字段说明 :

字段	类型	说明
tableColumnProperties	[]object	列属性

TableColumnProperties

普通表格的列宽。

{
    "width": int
}

字段说明 :

字段	类型	说明
width	int	列宽，单位 px，列宽最小 50，最大 1300，默认 100

MergedCell

合并的单元格。

{
    "mergedCellId": string,
    "rowStartIndex": int,
    "rowEndIndex": int,
    "columnStartIndex": int,
    "columnEndIndex": int
}

字段说明 :

字段	类型	说明
mergedCellId	string	合并单元格 id，不可编辑
rowStartIndex	int	合并单元格行起始索引，从 0 开始
rowEndIndex	int	合并单元格行截止索引
columnStartIndex	int	合并单元格列起始索引，从 0 开始
columnEndIndex	int	合并单元格列截止索引

Sheet

文档内的数据表格。通过获取文档富文本内容拿到的sheet token为token_tableId 的形式提供，在调用电子表格接口时，需要拆开后再使用，否则会报错。电子表格内容读写API。创建支持两种方式，二选一：

通过token深拷贝，token只允许doc内电子表格，不允许独立电子表格

指定rowSize和columnSize创建空sheet

{
    "token": string,
    "rowSize": int,
    "columnSize": int,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
token	string	sheet token，比如shtcnKjLimyn2fW0uGseasQYGgh_m7fMrN，其中，下划线前的是sheet token，下划线后的部分是tableId，使用时请注意拆分。在创建时，如果传入 token，则进行深拷贝。
rowSize	int	电子表格行数量。创建空电子表格时使用，最大值为 9
columnSize	int	电子表格列数量。创建空电子表格时使用，最大值为 9
location	Location	元素位置。仅返回，不支持写入

Bitable

文档内的多维表格，通过获取文档富文本内容拿到token。多维表格内容读写API。创建支持两种方式，二选一：

通过 token+viewType 深拷贝，token只允许doc内多维表格，不允许独立多维表格

不带 token，通过 viewType 创建空 bitable

{
    "token": string,
    "viewType": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
token	string	bitable token，比如shtcnKjLimyn2fW0uGseasQYGgh_m7fMrN创建接口或插入操作使用，如果非空，进行深拷贝。不可编辑
viewType	string	数据表：grid 看板：kanban
location	Location	元素位置。仅返回，不支持写入

Diagram

绘图，包含流程图和 UML 图。目前不支持写入。

{
    "token": string,
    "diagramType": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
token	string	diagram token, 比如diacnK1MYEHBopBbIdc6A5AOVCh，不支持编辑
diagramType	string	绘图类型。流程图：flowchart UML图：uml
location	Location	元素位置。仅返回，不支持写入

Jira

Jira，包括 Jira filter 和 Jira issue。目前不支持写入

{
    "token": string,
    "jiraType": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
token	string	jira token，比如 jftcnsA0fY8V3CzYvtRPy9XsXxf，不支持编辑
jiraType	string	Jira 类型。过滤器：filter 问题：issue
location	Location	元素位置。仅返回，不支持写入

Poll

投票。目前不支持写入。

{
    "token": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
token	string	poll token，比如 jsncnxuT7beirSpf33NfcKrSwAh，不支持编辑
location	Location	元素位置。仅返回，不支持写入

Code

{
    "language": string,
    "wrapContent": bool,
    "body": {object(Body)},
    "zoneId": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
language	string	代码语言支持以下语言: Plain Text, ABAP, Ada, Apache, Apex, Assembly language, Bash, C, C#, C++, COBOL, CSS, CoffeeScript, D, Dart, Delphi, Dockerfile, Django, Erlang, Fortran, FoxPro, Go, Groovy, HTML, HTMLBars, HTTP, Haskell, JSON, Java, JavaScript, Julia, Kotlin, LaTeX, Lisp, Logo, Lua, MATLAB, Makefile, Markdown, Nginx, Objective-C, OpenEdge ABL, PHP, Perl, PostScript, PowerShell, Prolog, ProtoBuf, Python, R, RPG, Ruby, Rust, SAS, SCSS, SQL, Scala, Scheme, Scratch, Shell, Swift, Thrift, TypeScript, VBScript, Visual Basic, XML, YAML
wrapContent	bool	是否自动换行
body	Object	代码块内容（只支持Paragraph block)
zoneId	string	Read only. 代码块的ID，对代码块内容进行增加修改删除时需要
location	Location	元素位置。仅返回，不支持写入

Callout

{
	"calloutEmojiId": string,										
	"calloutBackgroundColor": {object(RGBColor)},	
	"calloutBorderColor" {object(RGBColor)},
	"CalloutTextColor" {object(RGBColor)}, 
	"body": {object(Body)},
	"zoneId": string,
	"location": {object(Location)}
}

fields	type	Remark
calloutEmojiId	string	高亮块表情支持以下：emoji 枚举表
calloutBackgroundColor	RGBColor	高亮块背景色（分为深色系和浅色系，与边框色深浅色系对应）
calloutBorderColor	RGBColor	高亮块边框色（分为深色系和浅色系，与背景色深浅色系对应）
calloutTextColor	RGBColor	高亮块内文字颜色
body	Body	高亮块内容（仅支持Paragraph Block和HorizontalLine Block，ParagraphStyle支持除Collapse以外的所有）
zoneId	string	Read only. 高亮块的ID，对代码块内容进行增加修改删除时需要
location	Location	Read only. 高亮块位置

字体/背景/边框	枚举	色系	rgb	Alpha
字体颜色	CalloutRedText CalloutOrangeText CalloutYellowText CalloutGreenText CalloutBlueText CalloutPurpleText CalloutNeutralText	无	rgb(216,57,49) rgb(216,57,49) rgb(220,155,4) rgb(46,161,33) rgb(36,91,219) rgb(100,37,208) rgb(143,149,158)	1.0
背景色	CalloutLightRedBackground CalloutLightOrangeBackground CalloutLightYellowBackground CalloutLightGreenBackground CalloutLightBlueBackground CalloutLightPurpleBackground CalloutLightNeutralBackground CalloutDarkRedBackground CalloutDarkOrangeBackground CalloutDarkYellowBackground CalloutDarkGreenBackground CalloutDarkBlueBackground CalloutDarkPurpleBackground CalloutDarkNeutralBackground	亮色系暗色系	rgb(254,241,241) rgb(255,245,235) rgb(254,255,240) rgb(240,251,239) rgb(240,244,255) rgb(246,241,254) rgb(248,249,250) rgb(253,226,226) rgb(254,234,210) rgb(255,255,204) rgb(217,245,214) rgb(225,234,255) rgb(236,226,254) rgb(245,246,247)	1.0
边框色	CalloutRedBorder CalloutOrangeBorder CalloutYellowBorder CalloutGreenBorder CalloutBlueBorder CalloutPurpleBorder CalloutNeutralBorder	亮色系暗色系亮色系暗色系亮色系暗色系亮色系暗色系亮色系暗色系亮色系暗色系亮色系暗色系	rgb(251,191,188) rgb(249,142,139) rgb(254,212,164) rgb(255,186,107) rgb(255,246,122) rgb(255,242,88) rgb(183,237,177) rgb(142,224,133) rgb(186,206,253) rgb(130,167,252) rgb(205,178,250) rgb(173,130,247) rgb(222,224,227) rgb(187,191,196)	1.0

DocsApp

团队互动应用。目前不支持写入。

{
    "typeId": string,
    "instanceId": string,
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
typeId	string	团队互动应用类型，比如信息收集"blk_5f992038c64240015d280958"
instanceId	string	团队互动应用唯一ID
location	Location	元素位置。仅返回，不支持写入

UndefinedBlock

未支持的 Block 类型

{
    "location": {object(Location)}
}

字段说明 :

字段	类型	说明
location	Location	元素位置。仅返回，不支持写入

文档数据结构参考

Location#

Title#

Body#

Block#

Paragraph#

ParagraphStyle#

List#

ParagraphElement#

TextRun#

TextStyle#

RGBColor#

Link#

DocsLink#

Person#

Reminder#

Equation#

UndefinedElement#

Gallery#

GalleryStyle#

ImageItem#

File#

HorizontalLine#

EmbeddedPage#

ChatGroup#

Table#

TableRow#

TableCell#

TableStyle#

TableColumnProperties#

MergedCell#

Sheet#

Bitable#

Diagram#

Jira#

Poll#

Code#

Callout#

DocsApp#

UndefinedBlock#

Location

Title

Body

Block

Paragraph

ParagraphStyle

List

ParagraphElement

TextRun

TextStyle

RGBColor

Link

DocsLink

Person

Reminder

Equation

UndefinedElement

Gallery

GalleryStyle

ImageItem

File

HorizontalLine

EmbeddedPage

ChatGroup

Table

TableRow

TableCell

TableStyle

TableColumnProperties

MergedCell

Sheet

Bitable

Diagram

Jira

Poll

Code

Callout

DocsApp

UndefinedBlock