飞书云文档

连接参数

飞书云文档连接器使用token认证，创建连接时连接参数说明如表1所示。

获取评论列表

获取在线文档的全文评论列表信息。

• 输入参数
  输入参数说明如表2所示。

  表2 获取评论列表输入参数说明

  参数	必填	说明
  文档token	是	文档token。
  文档类型	是	文档类型 。支持输入框和下拉列表两种模式。 文档类型 电子表格类型 文件类型 新版文档类型

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表3。

  表3 获取评论列表输出参数说明

  参数	说明
  错误码	错误码。
  -是否还有更多项	在线文档评论是否还有更多项。
  -分页标记	文档评论的分页标记。
  -评论列表	文档评论的列表。
  --评论ID	文档评论的ID。
  --创建时间	文档评论的时间。
  --是否已解决	文档评论是否已解决。
  --评论里的回复列表	评论里的回复列表。
  ---回复列表	文档评论的回复列表。
  ---回复内容	回复内容。
  ----回复内容	回复文档评论的内容。
  -----文本内容	回复的文本内容。
  -----回复的内容元素	回复的内容元素。
  ----创建时间	创建时间。
  ----回复ID	回复ID。
  ----用户ID	用户ID。
  错误描述	错误描述。

获取文档纯文本内容（旧版）

获取文档的纯文本内容，不包含富文本格式信息。

• 输入参数
  输入参数说明如表4所示。

  表4 获取文档纯文本内容（旧版）输入参数说明

  参数	必填	说明
  文件的token	是	文件的token。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表5。

  表5 获取文档纯文本内容（旧版）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -文档内容	文档内容。

获取多维表格元数据

• 输入参数

  该执行动作无需输入参数。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表6。

  表6 获取多维表格元数据输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -多维表格元数据	多维表格元数据。
  --多维表格的app_token	多维表格的app_token。
  --多维表格的名字	多维表格的名字。
  --多维表格的版本号	多维表格的版本号。
  --多维表格是否已开启高级权限	多维表格是否已开启高级权限。

添加文档评论

给指定文档添加评论。

• 输入参数
  输入参数说明如表7所示。

  表7 添加文档评论输入参数说明

  参数	必填	说明
  用户ID	否	文档评论的用户ID。
  创建时间	否	创建评论时间。
  更新时间	否	更新评论时间。
  问题是否解决	否	问题是否解决。
  解决问题的时间	否	解决问题的时间。
  解决评论者的用户ID	否	解决评论者的用户ID。
  评论内容	是	评论的内容。
  文档token	是	评论文档的token。
  文档类型	是	评论文档的类型。 文档 新版文档
  用户ID类型	否	评论文档的用户ID类型。支持输入框和下拉列表两种模式。 open_id union_id user_id

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表8。

  表8 添加文档评论输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  -评论ID	评论ID。
  -创建时间	创建评论时间。
  -是否已解决	评论问题是否已解决。
  -评论里的回复列表	评论里的回复列表。
  --回复列表	回复评论列表。
  ---回复内容	回复评论的内容。
  ----回复的内容	回复的具体内容。
  ----文本内容	回复评论的文本内容。
  ----回复的内容元素	回复的内容元素。
  ---创建时间	回复评论的创建时间。
  ---回复ID	回复评论的ID。
  ---用户ID	回复评论的用户ID。
  错误描述	错误描述。

检索记录（多维表格）

根据指定数据表中的记录ID检索记录。

• 输入参数
  输入参数说明如表9所示。

  表9 检索记录（多维表格）输入参数说明

  参数	必填	说明
  数据表id	是	数据表的ID。
  单条记录的id	是	单条记录的ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表10。

  表10 检索记录（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -记录	记录。
  -记录字段	记录字段。
  -记录id	记录ID。 更新多条记录时必填。

更新记录（多维表格）

根据选择数据表更新记录（多维表格）。

• 输入参数
  输入参数说明如表11所示。

  表11 更新记录（多维表格）输入参数说明

  参数	必填	说明
  数据表id	是	数据表的ID。
  单条记录的id	是	单条记录的ID。
  新内容	是	新内容。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表12。

  表12 更新记录（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -记录	记录。
  -记录字段	记录字段。
  -记录id	记录ID。 更新多条记录时必填。

新建在线文档

创建并初始化文档。

• 输入参数
  输入参数说明如表13所示。

  表13 新建在线文档输入参数说明

  参数	必填	说明
  文件夹token	否	文件夹token。
  标题	否	标题。
  正文内容	否	正文内容。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表14。

  表14 新建在线文档输出参数说明

  参数	说明
  新建文档的token	新建文档的token。
  新建文档的访问链接	新建文档的访问链接。

新增记录（多维表格）

根据选择数据表新增记录。

• 输入参数
  输入参数说明如表15所示。

  表15 新增记录（多维表格）输入参数说明

  参数	必填	说明
  数据表id	是	数据表的ID。
  多行文本内容	是	多行文本内容。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表16。

  表16 新增记录（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -记录	记录。
  -记录id	记录ID。 更新多条记录时必填。
  -记录字段	记录字段。

新增数据表（多维表格）

• 输入参数
  输入参数说明如表17所示。

  表17 新增数据表（多维表格）输入参数说明

  参数	必填	说明
  数据表名字	是	数据表的名字。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表18。

  表18 新增数据表（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  多维表格id	多维表格的ID。

新增多个数据表（多维表格）

• 输入参数
  输入参数说明如表19所示。

  表19 新增多个数据表（多维表格）输入参数说明

  参数	必填	说明
  数据表名字	是	数据表的名字。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表20。

  表20 新增多个数据表（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  table ids	多个数据表的ID。

删除记录（多维表格）

根据指定数据表的记录ID删除记录。

• 输入参数
  输入参数说明如表21所示。

  表21 删除记录（多维表格）输入参数说明

  参数	必填	说明
  数据表id	是	数据表的ID。
  单条记录的Id	是	单条记录的ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表22。

  表22 删除记录（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -是否成功删除	是否成功删除。
  -删除的记录ID	删除的记录ID。

删除数据表（多维表格）

• 输入参数
  输入参数说明如表23所示。

  表23 删除数据表（多维表格）输入参数说明

  参数	必填	说明
  数据表id	是	数据表的ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表24。

  表24 删除数据表（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。

删除多个数据表（多维表格）

• 输入参数
  输入参数说明如表25所示。

  表25 删除多个数据表（多维表格）输入参数说明

  参数	必填	说明
  删除的多条tableid列表	是	删除多个数据表的多条tableid列表。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表26。

  表26 删除多个数据表（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。

列出记录（多维表格）

根据选择数据表列出数据表中所有记录信息。

• 输入参数

  该执行动作无输入参数。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表27。

  表27 列出记录（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -是否还有更多项	是否还有更多项。
  -分页标记	分页标记。
  -总数	总数。
  记录信息	记录信息。
  -记录id	数据表中记录的ID。
  -fields	记录字段。

列出数据表（多维表格）

• 输入参数
  输入参数说明如表28所示。

  表28 列出数据表（多维表格）输入参数说明

  参数	必填	说明
  分页标记	否	分页标记。 第一次请求不填，表示从头开始遍历。分页查询结果还有更多项时，会同时返回新的page_token，下次遍历可采用该page_token获取查询结果。
  分页大小	否	分页大小。 最大值：100

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表29。

  表29 列出数据表（多维表格）输出参数说明

  参数	说明
  错误码	错误码。 非0表示失败。
  错误描述	错误描述。
  -是否还有更多项	是否还有更多项。
  -分页标记	分页标记。
  -总数	总数。
  数据表信息	数据表信息。
  -数据表id	数据表的ID。
  -数据表的版本号	数据表的版本号。
  -数据表名字	数据表的名字。