docs/channels/feishu.mdx
<Note> 接入需要是飞书企业用户且具有企业管理权限。 </Note>通过飞书自建应用接入 CowAgent,支持单聊与群聊(@机器人),使用 WebSocket 长连接模式,无需公网 IP,支持流式打字机回复、语音消息收发。
启动 Cow 项目后在终端中即可完成扫码创建。或打开 Web 控制台(本地链接:http://127.0.0.1:9899 ),选择 通道 菜单,点击 接入通道,选择 飞书,点击 一键创建飞书应用,使用 飞书 App 扫描二维码即可自动完成应用创建并接入:
<Note> 1. `lark-oapi` 依赖版本需要 >=1.5.5 2. 扫码创建出的应用会自动预置全部所需权限(消息收发、卡片读写、群聊事件等)和事件订阅,无需到开发者后台手动配置。 </Note>需要先在飞书开放平台创建自建应用并配置权限,再通过 Web 控制台或配置文件接入。
步骤一:创建应用
进入 飞书开发平台,点击 创建企业自建应用:
在 添加应用能力 中,为应用添加 机器人 能力:
在 权限管理 中,将以下权限粘贴到输入框,全选并 批量开通:
im:message,im:message.group_at_msg,im:message.group_at_msg:readonly,im:message.p2p_msg,im:message.p2p_msg:readonly,im:message:send_as_bot,im:resource,cardkit:card:write
App ID 和 App Secret:步骤二:接入 CowAgent
<Tabs> <Tab title="Web 控制台"> 打开 Web 控制台,选择 **通道** 菜单,点击 **接入通道**,选择 **飞书**,切换到「手动填写」Tab,输入 App ID 和 App Secret,点击接入即可。 </Tab> <Tab title="配置文件"> 在 `config.json` 中添加以下配置后启动程序:```json
{
"channel_type": "feishu",
"feishu_app_id": "YOUR_APP_ID",
"feishu_app_secret": "YOUR_APP_SECRET",
"feishu_stream_reply": true
}
```
| 参数 | 说明 | 默认值 |
| --- | --- | --- |
| `feishu_app_id` | 飞书应用 App ID | - |
| `feishu_app_secret` | 飞书应用 App Secret | - |
| `feishu_stream_reply` | 是否开启流式打字机回复 | `true` |
步骤三:发布应用
启动 Cow 项目后,在飞书开放平台点击 事件与回调,选择 长连接 模式并保存:
点击 添加事件,搜索 "接收消息",选择 接收消息 v2.0 并确认。
点击 版本管理与发布,创建版本并申请 线上发布,在飞书客户端审核通过:
| 功能 | 支持情况 |
|---|---|
| 单聊 | ✅ |
| 群聊(@机器人) | ✅ |
| 文本消息 | ✅ 收发 |
| 图片消息 | ✅ 收发 |
| 语音消息 | ✅ 收发 |
| 流式回复 | ✅(通过 feishu_stream_reply 配置控制,默认开启) |
完成接入后,在飞书中搜索机器人名称即可开始单聊对话。
如需在群聊中使用,将机器人添加到群中,@机器人发送消息即可。