飞书平台连接器获取及设置指南
连接器获取
应用连接器获取
获取应用连接器需要先参考文档:飞书API调用指南。
创建应用
在开放平台创建应用:创建应用
应用授权
根据所需接口获取相应权限,批量申请权限。
应用发版
完成授权后,选择应用并进行版本发布,需通过审核。参数说明:
host
: 飞书API接口地址,例如:https://open.feishu.cnapp_id
: 飞书应用的app_idapp_secret
: 飞书应用的secret
方案配置指南
适配器介绍
- FSExecuteAdapter: 写入适配器
- FSQueryAdapter: 查询适配器
- FSApprovalExecuteAdapter: 审批写入适配器
- FSApprovalQueryAdapter: 审批查询适配器
- GetUserAdapter: 通过部门查询用户信息
查询方案配置示例
示例链接:
请求参数说明
path参数说明
在飞书API中,某些参数需要放在请求路径中。例如查询部门列表时:
https://open.feishu.cn/document/server-docs/contact-v3/department/children
路径中的 department_id
需要进行路径替换。
query参数说明
参数放在请求地址的query中,例如用户查询:
https://open.feishu.cn/document/server-docs/contact-v3/user/find_by_department?appId=cli_a53a6fbf04e7500c
其中 department_id
,page_size
,page_token
参数放在 open-apis/contact/v3/users/find_by_department
接口后面的query参数中。
body参数说明
大部分POST请求的body参数放在请求参数的request中。
方案配置说明
参数配置指南
- query参数放在请求参数request中,其他请求参数放在otherRequest中,生成队列时会自动带上query关键字。
- path参数放在其他请求参数otherRequest中,并需配置path关键字。
- body参数放在请求参数request中,一般用于POST、DELETE等请求方法。如果同时存在query参数,则需配置到其他请求参数otherRequest中。
{
"query": {"page_size": "20", "page_token": ""},
"path": {"department_id": "od-2a6fe844c6c51e8bc069815eaf72236f"}
}
- 若通过部门查询客户列表,请配置参数
dep_strategy
: 部门方案ID。 - 部门审批请参考链接:飞书审批配置教程