# 飞书云文档 通过飞书云文档连接器，可以获取在线文档的评论信息、创建在线文档、新增数据表等。 #### 连接参数 飞书云文档连接器使用token认证，创建连接时连接参数说明如[表1]所示。 表1连接参数说明 | 名称 | 必填 | 说明 | 示例值/默认值 | |:---|:---|:---|:---| | 连接名称 | 是 | 设置连接名称。 | 飞书云文档 | | 描述 | 否 | 对于连接的信息描述说明。 | description。 | | App ID | 是 | 应用ID。 | 该连接器需要用户自建应用并获取应用ID和应用密钥。具体操作如下： 1. 登录[++飞书++](https://www.feishu.cn/)，单击右上方的九方格，单击"管理后台"进入飞书管理后台。 2. 从左侧菜单栏选择"工作台 \> 应用管理"进入，单击"创建应用"。 3. 单击"创建企业自建应用"。 输入应用名称、应用描述，并上传应用图标，单击"确定创建"。 自建应用创建完成后，应用状态显示"待上线"。 4. 单击刚创建的自建应用，从左侧菜单栏选择"管理权限 \> 云文档"，勾选"权限名称"，单击"批量开通"，在弹出的提示窗口中，单击"确认"。 5. 权限批量开通后，页面顶部自动弹出橙色提示条，单击"点击创建"进入。 6. 在版本管理与发布界面，单击"创建版本"。 输入应用版本号、更新说明，填写完成后，单击"保存"。 7. 进入版本详情界面，单击"申请发布"。 8. 返回飞书管理后台，从左侧菜单栏选择"工作台 \> 应用审核"进入，搜索刚创建的自建应用，单击"审核"，再单击"通过"，系统自动提示此应用通过审核，自建应用添加完成。 9. 打开刚创建的自建应用，单击"凭证与基础信息"，获取App ID和App Secret。 | | APP Secret | 是 | 应用密钥。 | 该连接器需要用户自建应用并获取应用ID和应用密钥。具体操作如下： 1. 登录[++飞书++](https://www.feishu.cn/)，单击右上方的九方格，单击"管理后台"进入飞书管理后台。 2. 从左侧菜单栏选择"工作台 \> 应用管理"进入，单击"创建应用"。 3. 单击"创建企业自建应用"。 输入应用名称、应用描述，并上传应用图标，单击"确定创建"。 自建应用创建完成后，应用状态显示"待上线"。 4. 单击刚创建的自建应用，从左侧菜单栏选择"管理权限 \> 云文档"，勾选"权限名称"，单击"批量开通"，在弹出的提示窗口中，单击"确认"。 5. 权限批量开通后，页面顶部自动弹出橙色提示条，单击"点击创建"进入。 6. 在版本管理与发布界面，单击"创建版本"。 输入应用版本号、更新说明，填写完成后，单击"保存"。 7. 进入版本详情界面，单击"申请发布"。 8. 返回飞书管理后台，从左侧菜单栏选择"工作台 \> 应用审核"进入，搜索刚创建的自建应用，单击"审核"，再单击"通过"，系统自动提示此应用通过审核，自建应用添加完成。 9. 打开刚创建的自建应用，单击"凭证与基础信息"，获取App ID和App Secret。 | | App token | 是 | 应用token。 | 获取app token方式如下： 1. 进入飞书文档官网，登录账号。 2. 进入飞书文档，单击"创建 \> 新建文档"。 3. 单击"新建空白文档"。 4. 从新的浏览器地址栏获取token（以下加粗部分）。 https://zbqj0yxifx.feishu.cn/docx/**doxcn2AJ6U4Wqbe7h6l9jtAKAKb** | #### 获取评论列表 获取在线文档的全文评论列表信息。 - 输入参数 输入参数说明如[表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。 | | -数据表的版本号 | 数据表的版本号。 | | -数据表名字 | 数据表的名字。 |