飞书平台配置指南

说明：本文主要介绍飞书平台连接器获取及设置、接口请求类型（POST, GET）、方案配置设置指南、适配器介绍。

一、连接器获取指南

1.1 应用连接器获取指南

文档地址：https://open.feishu.cn/document/server-docs/api-call-guide/server-api-list

1.1.1 在开放平台创建应用

链接地址：https://open.feishu.cn/app?lang=zh-CN

1.1.2 应用授权

根据调用接口获取对应权限信息，批量获取权限。

1.1.3 应用发版

应用授权之后，选择对应应用，进行版本发版。还需要通过审核。

参数说明：

• host：飞书API接口地址。示例：https://open.feishu.cn
• app_id：飞书应用的app_id
• app_secret：飞书应用的secret

二、方案配置指南

2.1 适配器介绍

• FSExecuteAdapter：写入适配器
• FSQueryAdapter：查询适配器
• FSApprovalExecuteAdapter：审批写入适配器
• FSApprovalQueryAdapter：审批查询适配器
• GetUserAdapter：通过部门查询用户信息
• FsSheetQueryAdapter：飞书表格查询适配器

2.2 查询方案配置示例

• 部门查询示例：https://pro.qliang.cloud/strategy/detail/72584096-2ee3-3494-8e00-fedf6255f98a#BasicSummary
• 用户查询示例：https://pro.qliang.cloud/strategy/detail/c5ebe075-99a4-3967-9242-6d2a8236c328#BasicSummary
• 审批示例：https://pro.qliang.cloud/strategy/detail/1b4b8cab-a906-3a82-a8d5-960a7c7a4abe#BasicSummary
• 表格示例: https://pro.qliang.cloud/strategy/detail/0ac4cb8b-5007-3cb5-80f2-9205aed0a648#BasicSummary

2.3 请求参数说明

2.3.1 path参数说明

在飞书的API中，有些参数需要放到请求地址path中。

示例：查询部门列表

• API文档：https://open.feishu.cn/document/server-docs/contact-v3/department/children
• 接口路径：/open-apis/contact/v3/departments/:department_id/children
• 其中 department_id 需要进行路径替换

2.3.2 query参数说明

参数是放到请求地址的query里面。

示例：用户查询

• API文档：https://open.feishu.cn/document/server-docs/contact-v3/user/find_by_department?appId=cli_a53a6fbf04e7500c
• 接口路径：/open-apis/contact/v3/users/find_by_department
• query参数：department_id、page_size、page_token 通过 ? 拼接到接口后面

2.3.3 body参数说明

用于POST请求参数。大部分body参数是放到请求参数request里面。

2.4 方案配置说明

2.4.1 参数配置指南

1. query参数：放在请求参数request、其他请求参数otherRequest中。在生成队列时，会自动带上query关键字。

2. path参数：放在其他请求参数otherRequest中，且需要配置path关键字。

3. body参数：放在请求参数request中，一般在请求方法为POST、DELETE等才会有。如果此时还有query参数，需要配置到其他请求参数otherRequest里面。

配置示例：

{
  "query": {
    "page_size": "20",
    "page_token": ""
  },
  "path": {
    "department_id": "od-2a6fe844c6c51e8bc069815eaf72236f"
  }
}

4. 部门查询用户配置：如果是通过部门查询客户列表，请配置参数 dep_strategy：部门方案ID。

5. 部门审批配置：请查询链接 https://bbs.qeasy.cloud/d/12715-fei-shu-shen-pi-pei-zhi-jiao-cheng/2

6. 飞书表格查询配置

飞书表格查询使用 FsSheetQueryAdapter 适配器，支持读取飞书电子表格数据。

API文档：https://open.feishu.cn/document/server-docs/docs/sheets-v1/spreadsheet-sheet/query

otherRequest参数配置表：

valueRenderOption 选项说明：

dateTimeRenderOption 选项说明：

配置示例：

{
  "query": {
    "valueRenderOption": "ToString",
    "dateTimeRenderOption": "FormattedString"
  },
  "path": {
    "spreadsheetToken": "PZ2Asa69ZhClF9tzVUjcN8H1nV8",
    "range": "0ad5ec!B:I"
  }
}

Range参数格式说明：

获取spreadsheetToken方法：
从飞书表格URL中提取，例如：
https://example.feishu.cn/sheets/PZ2Asa69ZhClF9tzVUjcN8H1nV8
其中 PZ2Asa69ZhClF9tzVUjcN8H1nV8 就是spreadsheetToken。