飞书 / Lark 配置
Hermes Agent 以功能完整的机器人身份集成到飞书和 Lark。连接后,你可以在私信或群聊中与 Agent 对话,在主频道接收定时任务结果,并通过正常的网关流程发送文本、图片、音频和文件附件。
该集成支持两种连接模式:
websocket——推荐;由 Hermes 发起出站连接,无需公网 Webhook 端点webhook——适用于你的网关已在可访问的 HTTP 端点后运行的场景
Hermes 的行为
| 场景 | 行为 |
|---|---|
| 私信 | Hermes 回复每条消息。 |
| 群聊 | Hermes 仅在被 @提及 时响应。 |
| 多用户共享群聊 | 默认情况下,共享群聊中的会话历史按用户隔离。 |
共享群聊的行为由 config.yaml 控制:
group_sessions_per_user: true
仅当你明确希望每个群聊共享同一对话时才设置为 false。
步骤 1:创建飞书 / Lark 应用
推荐:扫码创建(一条命令)
hermes gateway setup
选择 飞书 / Lark,用飞书或 Lark 移动应用扫描二维码。Hermes 会自动创建具有正确权限的机器人应用并保存凭证。
备选:手动设置
如果扫码创建不可用,向导会回退到手动输入:
- 打开飞书或 Lark 开发者控制台:
- 创建新应用。
- 在凭证与基础信息中,复制 App ID 和 App Secret。
- 为应用开启机器人能力。
- 运行
hermes gateway setup,选择飞书 / Lark,并在提示时输入凭证。
请妥善保管 App Secret。任何持有它的人都可以冒充你的应用。
步骤 2:选择连接模式
推荐:WebSocket 模式
当 Hermes 运行在你的笔记本、工作站或私有服务器上时,使用 WebSocket 模式。无需公网 URL。官方 Lark SDK 会打开并维护一个持久的出站 WebSocket 连接,并自动重连。
FEISHU_CONNECTION_MODE=websocket
前提条件: 必须安装 websockets Python 包。SDK 在内部处理连接生命周期、心跳和自动重连。
工作原理: 适配器在后台执行线程中运行 Lark SDK 的 WebSocket 客户端。入站事件(消息、表情反应、卡片操作)被分发到主 asyncio 循环。断线时,SDK 会自动尝试重连。
可选:Webhook 模式
仅在你的 Hermes 已运行在可访问的 HTTP 端点后时使用 Webhook 模式。
FEISHU_CONNECTION_MODE=webhook
在 Webhook 模式下,Hermes 启动一个 HTTP 服务器(通过 aiohttp),并在以下路径提供飞书端点:
/feishu/webhook
前提条件: 必须安装 aiohttp Python 包。
你可以自定义 Webhook 服务器的绑定地址和路径:
FEISHU_WEBHOOK_HOST=127.0.0.1 # 默认:127.0.0.1
FEISHU_WEBHOOK_PORT=8765 # 默认:8765
FEISHU_WEBHOOK_PATH=/feishu/webhook # 默认:/feishu/webhook
当飞书发送 URL 验证挑战(type: url_verification)时,Webhook 会自动响应,便于你在飞书开发者控制台完成订阅配置。
步骤 3:配置 Hermes
方式 A:交互式设置
hermes gateway setup
选择飞书 / Lark,填写提示信息。
方式 B:手动配置
在 ~/.hermes/.env 中添加以下内容:
FEISHU_APP_ID=cli_xxx
FEISHU_APP_SECRET=secret_xxx
FEISHU_DOMAIN=feishu
FEISHU_CONNECTION_MODE=websocket
# 可选但强烈推荐
FEISHU_ALLOWED_USERS=ou_xxx,ou_yyy
FEISHU_HOME_CHANNEL=oc_xxx
FEISHU_DOMAIN 接受:
feishu——飞书中国lark——Lark 国际版
步骤 4:启动网关
hermes gateway
然后从飞书/Lark 向机器人发送消息,确认连接正常。
主频道
在飞书/Lark 会话中使用 /set-home 将其设为定时任务结果和跨平台通知的主频道。
也可以预先配置:
FEISHU_HOME_CHANNEL=oc_xxx
安全
用户允许列表
在生产环境中,设置飞书 Open ID 的允许列表:
FEISHU_ALLOWED_USERS=ou_xxx,ou_yyy
如果留空,任何能访问机器人的人都可能使用它。在群聊中,消息处理前会根据发送者的 open_id 检查允许列表。
Webhook 加密密钥
在 Webhook 模式下,设置加密密钥以启用入站 Webhook 载荷的签名验证:
FEISHU_ENCRYPT_KEY=your-encrypt-key
此密钥可在飞书应用配置的事件订阅部分找到。设置后,适配器使用以下签名算法验证每个 Webhook 请求:
SHA256(timestamp + nonce + encrypt_key + body)
计算出的哈希值与 x-lark-signature 头部进行时序安全比对。签名无效或缺失的请求会被拒绝,返回 HTTP 401。
在 WebSocket 模式下,签名验证由 SDK 自身处理,因此 FEISHU_ENCRYPT_KEY 是可选的。在 Webhook 模式下,生产环境强烈推荐设置。
验证令牌
额外的身份验证层,用于检查 Webhook 载荷中的 token 字段:
FEISHU_VERIFICATION_TOKEN=your-verification-token
此令牌也可在飞书应用的事件订阅部分找到。设置后,每个入站 Webhook 载荷的 header 对象中必须包含匹配的 token。令牌不匹配的请求会被拒绝,返回 HTTP 401。
FEISHU_ENCRYPT_KEY 和 FEISHU_VERIFICATION_TOKEN 可同时使用,实现纵深防御。
群组消息策略
FEISHU_GROUP_POLICY 环境变量控制 Hermes 是否以及如何在群聊中响应:
FEISHU_GROUP_POLICY=allowlist # 默认
| 值 | 行为 |
|---|---|
open | Hermes 响应任意群组中任何用户的 @提及。 |
allowlist | Hermes 仅响应 FEISHU_ALLOWED_USERS 中列出用户的 @提及。 |
disabled | Hermes 完全忽略所有群组消息。 |
在所有模式下,消息处理前机器人必须被明确 @提及(或 @全体成员)。私信始终绕过此限制。
设置 FEISHU_REQUIRE_MENTION=false 可让 Hermes 读取所有群组消息,无需 @提及:
FEISHU_REQUIRE_MENTION=false
如需单个群聊级别的控制,可在 group_rules 条目中设置 require_mention——详见下方的按群组访问控制。
机器人身份
Hermes 在启动时会自动检测机器人的 open_id 和显示名称。仅当自动检测无法访问飞书 API,或应用使用租户级别用户 ID 时,才需要手动设置:
FEISHU_BOT_OPEN_ID=ou_xxx # 仅在自动检测失败时使用
FEISHU_BOT_USER_ID=xxx # 若应用使用 sender_id_type=user_id 则必须设置
FEISHU_BOT_NAME=MyBot # 仅在自动检测失败时使用
机器人间消息
默认情况下,Hermes 忽略其他机器人发送的消息。当你希望 Hermes 参与 A2A 编排或接收同一群组中其他机器人的通知时,启用机器人间消息功能。
FEISHU_ALLOW_BOTS=mentions # 默认:none
| 值 | 行为 |
|---|---|
none | 忽略所有来自其他机器人的消息(默认)。 |
mentions | 仅在对等机器人 @提及 Hermes 时才接受。 |
all | 接受所有对等机器人的消息。 |
也可在 config.yaml 中配置为 feishu.allow_bots(同时设置时环境变量优先)。
对等机器人无需添加到 FEISHU_ALLOWED_USERS——该允许列表仅适用于真人发送者。
授予 application:bot.basic_info:read 权限范围可显示对等机器人名称;不授予时,对等机器人仍能正常路由,但显示为其 open_id。
交互式卡片操作
当用户点击按钮或与机器人发送的交互式卡片交互时,适配器将这些操作路由为合成的 /card 命令事件:
- 按钮点击变为:
/card button {"key": "value", ...} - 卡片定义中操作的
value载荷以 JSON 格式包含。 - 卡片操作使用 15 分钟窗口进行去重,防止重复处理。
网关驱动的更新提示使用飞书原生 是 / 否 卡片,而不是回退到纯文本回复。当 hermes update --gateway 需要确认时,适配器将选择答案记录到 Hermes 的 .update_response 文件中,并内联替换卡片为已解决状态。
卡片操作事件以 MessageType.COMMAND 类型分发,因此流经正常的命令处理管道。
这也是命令审批的工作方式——当 Agent 需要执行危险命令时,它会发送带有"允许一次 / 本次会话 / 始终允许 / 拒绝"按钮的交互式卡片。用户点击按钮,卡片操作回调将审批决定传递回 Agent。
飞书应用配置要求
交互式卡片需要在飞书开发者控制台完成三个配置步骤。缺少任意一个都会导致用户点击卡片按钮时出现错误 200340。
-
订阅卡片操作事件: 在事件订阅中,将
card.action.trigger添加到已订阅事件列表。 -
启用交互式卡片能力: 在应用功能 > 机器人中,确保交互式卡片开关已开启。这告知飞书你的应用可以接收卡片操作回调。
-
配置卡片请求 URL(仅限 Webhook 模式): 在应用功能 > 机器人 > 消息卡片请求网址中,将 URL 设置为与事件 Webhook 相同的端点(例如
https://your-server:8765/feishu/webhook)。WebSocket 模式下,此项由 SDK 自动处理。
若缺少上述三个步骤,飞书虽然能成功发送交互式卡片(发送仅需 im:message:send 权限),但用户点击任何按钮都会返回错误 200340。卡片看起来正常——错误只在用户与其交互时才会出现。
文档评论智能回复
除聊天功能外,适配器还能回复留在飞书/Lark 文档上的 @-提及。当用户在文档中评论(局部文字选取或全文评论)并 @提及 机器人时,Hermes 读取文档内容和周边评论线程,并以 LLM 回复的形式内联回复到线程中。
由 drive.notice.comment_add_v1 事件驱动,处理器会:
- 并行获取文档内容和评论时间线(全文评论线程最多 20 条,局部选取线程最多 12 条)。
- 使用范围限定于该单条评论会话的
feishu_doc+feishu_drive工具集运行 Agent。 - 将回复分块为 4000 字符并作为线程回复发回。
- 按文档缓存会话,有效期 1 小时、上限 50 条消息,确保同一文档的后续评论能保持上下文。
三级访问控制
文档评论回复采用显式授权机制——不存在隐式全员允许模式。权限按以下优先级解析(每个字段取第一个匹配项):
- 精确文档——范围限定于特定文档 token 的规则。
- 通配符——匹配文档模式的规则。
- 顶级——工作空间的默认规则。
每条规则提供两种策略:
allowlist——用户/租户的静态列表。pairing——静态列表 ∪ 运行时审批存储。适合管理员可在线授权的场景。
规则存储在 ~/.hermes/feishu_comment_rules.json(配对授权在 ~/.hermes/feishu_comment_pairing.json),使用基于 mtime 的热重载缓存——编辑后无需重启网关即可在下一条评论事件时生效。
CLI:
# 查看当前规则和配对状态
python -m gateway.platforms.feishu_comment_rules status
# 模拟特定文档 + 用户的访问检查
python -m gateway.platforms.feishu_comment_rules check <fileType:fileToken> <user_open_id>
# 运行时管理配对授权
python -m gateway.platforms.feishu_comment_rules pairing list
python -m gateway.platforms.feishu_comment_rules pairing add <user_open_id>
python -m gateway.platforms.feishu_comment_rules pairing remove <user_open_id>
飞书应用配置要求
在已授予的聊天/卡片权限基础上,还需添加文档评论事件:
- 在事件订阅中订阅
drive.notice.comment_add_v1。 - 授予
docs:doc:readonly和drive:drive:readonly权限范围,以便处理器读取文档内容。
媒体支持
入站(接收)
适配器接收并缓存来自用户的以下媒体类型:
| 类型 | 扩展名 | 处理方式 |
|---|---|---|
| 图片 | .jpg, .jpeg, .png, .gif, .webp, .bmp | 通过飞书 API 下载并本地缓存 |
| 音频 | .ogg, .mp3, .wav, .m4a, .aac, .flac, .opus, .webm | 下载并缓存;小型文本文件自动提取内容 |
| 视频 | .mp4, .mov, .avi, .mkv, .webm, .m4v, .3gp | 下载并以文档形式缓存 |
| 文件 | .pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx 等 | 下载并以文档形式缓存 |
富文本(帖子)消息中的媒体,包括内嵌图片和文件附件,也会被提取并缓存。
对于小型文本类文档(.txt、.md),文件内容会自动注入到消息文本中,使 Agent 无需使用工具即可直接读取。
出站(发送)
| 方法 | 发送内容 |
|---|---|
send | 文本或富文本帖子消息(根据 Markdown 内容自动检测) |
send_image / send_image_file | 上传图片到飞书,然后以原生图片气泡发送(支持可选说明文字) |
send_document | 通过飞书 API 上传文件,然后以文件附件形式发送 |
send_voice | 以飞书文件附件形式上传音频文件 |
send_video | 上传视频并以原生媒体消息形式发送 |
send_animation | GIF 降级为文件附件(飞书没有原生 GIF 气泡) |
文件上传路由根据扩展名自动判断:
.ogg、.opus→ 以opus音频上传.mp4、.mov、.avi、.m4v→ 以mp4媒体上传.pdf、.doc(x)、.xls(x)、.ppt(x)→ 以对应文档类型上传- 其他所有文件 → 以通用流文件上传
Markdown 渲染与帖子降级
当出站文本包含 Markdown 格式(标题、粗体、列表、代码块、链接等)时,适配器会自动将其作为飞书帖子消息(嵌入 md 标签)而非纯文本发送,在飞书客户端中实现富文本渲染。
若飞书 API 拒绝帖子载荷(例如因为不支持的 Markdown 结构),适配器会自动降级为发送去除 Markdown 的纯文本。这种两阶段降级机制确保消息始终能被投递。
不含 Markdown 的纯文本消息以简单的 text 消息类型发送。
处理状态表情反应
Agent 工作时,机器人会在你的消息上显示 正在输入 表情反应。回复到达时清除,或在处理失败时替换为 叉号。
设置 FEISHU_REACTIONS=false 可关闭此功能。
突发保护与批处理
适配器内置了针对快速连续消息的防抖机制,避免 Agent 过载:
文本批处理
当用户快速连续发送多条文本消息时,这些消息会在分发前合并为单个事件:
| 设置 | 环境变量 | 默认值 |
|---|---|---|
| 静默期 | HERMES_FEISHU_TEXT_BATCH_DELAY_SECONDS | 0.6s |
| 每批最大消息数 | HERMES_FEISHU_TEXT_BATCH_MAX_MESSAGES | 8 |
| 每批最大字符数 | HERMES_FEISHU_TEXT_BATCH_MAX_CHARS | 4000 |
媒体批处理
快速连续发送的多个媒体附件(例如拖拽多张图片)会合并为单个事件:
| 设置 | 环境变量 | 默认值 |
|---|---|---|
| 静默期 | HERMES_FEISHU_MEDIA_BATCH_DELAY_SECONDS | 0.8s |
按会话串行处理
同一会话内的消息按顺序串行处理(每次处理一条),以维持对话连贯性。每个会话有独立的锁,不同会话的消息可以并发处理。
速率限制(Webhook 模式)
在 Webhook 模式下,适配器对每个 IP 执行速率限制以防止滥用:
- 窗口: 60 秒滑动窗口
- 限制: 每个(app_id、路径、IP)三元组每窗口 120 个请求
- 跟踪上限: 最多跟踪 4096 个唯一键(防止内存无限增长)
超出限制的请求收到 HTTP 429(请求过多)。
Webhook 异常跟踪
适配器跟踪每个 IP 地址的连续错误响应。同一 IP 在 6 小时窗口内连续出现 25 次错误后会记录警告。有助于检测配置错误的客户端或探测行为。
其他 Webhook 保护措施:
- 请求体大小限制: 最大 1 MB
- 请求体读取超时: 30 秒
- Content-Type 强制: 仅接受
application/json
WebSocket 调优
使用 websocket 模式时,可以自定义重连和 ping 行为:
platforms:
feishu:
extra:
ws_reconnect_interval: 120 # 重连尝试间隔秒数(默认:120)
ws_ping_interval: 30 # WebSocket ping 间隔秒数(可选;不设置则使用 SDK 默认值)
| 设置 | 配置键 | 默认值 | 描述 |
|---|---|---|---|
| 重连间隔 | ws_reconnect_interval | 120s | 两次重连尝试之间的等待时间 |
| Ping 间隔 | ws_ping_interval | (SDK 默认) | WebSocket 保活 ping 的频率 |
按群组访问控制
除全局 FEISHU_GROUP_POLICY 外,还可以在 config.yaml 的 group_rules 中为每个群聊设置精细规则:
platforms:
feishu:
extra:
default_group_policy: "open" # 不在 group_rules 中的群组的默认策略
admins: # 可以管理机器人设置的用户
- "ou_admin_open_id"
group_rules:
"oc_group_chat_id_1":
policy: "allowlist" # open | allowlist | blacklist | admin_only | disabled
allowlist:
- "ou_user_open_id_1"
- "ou_user_open_id_2"
"oc_group_chat_id_2":
policy: "admin_only"
"oc_group_chat_id_3":
policy: "blacklist"
blacklist:
- "ou_blocked_user"
"oc_free_chat":
policy: "open"
require_mention: false # 覆盖此会话的 FEISHU_REQUIRE_MENTION
| 策略 | 描述 |
|---|---|
open | 群组中的任何人都可以使用机器人 |
allowlist | 只有群组 allowlist 中的用户才能使用机器人 |
blacklist | 除群组 blacklist 中的用户外,所有人都能使用机器人 |
admin_only | 只有全局 admins 列表中的用户可以在此群组中使用机器人 |
disabled | 机器人忽略此群组中的所有消息 |
在 group_rules 条目中设置 require_mention: false 可跳过该特定会话的 @提及 要求。省略时,该会话继承全局 FEISHU_REQUIRE_MENTION 的值。
未列在 group_rules 中的群组回退到 default_group_policy(默认为 FEISHU_GROUP_POLICY 的值)。
消息去重
入站消息使用消息 ID 进行去重,TTL 为 24 小时。去重状态持久化到 ~/.hermes/feishu_seen_message_ids.json,重启后仍然有效。
| 设置 | 环境变量 | 默认值 |
|---|---|---|
| 缓存大小 | HERMES_FEISHU_DEDUP_CACHE_SIZE | 2048 条 |
所有环境变量
| 变量 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
FEISHU_APP_ID | ✅ | — | 飞书/Lark App ID |
FEISHU_APP_SECRET | ✅ | — | 飞书/Lark App Secret |
FEISHU_DOMAIN | — | feishu | feishu(中国)或 lark(国际版) |
FEISHU_CONNECTION_MODE | — | websocket | websocket 或 webhook |
FEISHU_ALLOWED_USERS | — | (空) | 用户允许列表的 open_id,逗号分隔 |
FEISHU_ALLOW_BOTS | — | none | 接受来自其他机器人的消息:none、mentions 或 all |
FEISHU_REQUIRE_MENTION | — | true | 群组消息是否必须 @提及 机器人 |
FEISHU_HOME_CHANNEL | — | — | 定时任务/通知输出的会话 ID |
FEISHU_ENCRYPT_KEY | — | (空) | Webhook 签名验证的加密密钥 |
FEISHU_VERIFICATION_TOKEN | — | (空) | Webhook 载荷鉴权的验证令牌 |
FEISHU_GROUP_POLICY | — | allowlist | 群组消息策略:open、allowlist、disabled |
FEISHU_BOT_OPEN_ID | — | (空) | 机器人的 open_id(用于 @提及 检测) |
FEISHU_BOT_USER_ID | — | (空) | 机器人的 user_id(用于 @提及 检测) |
FEISHU_BOT_NAME | — | (空) | 机器人的显示名称(用于 @提及 检测) |
FEISHU_WEBHOOK_HOST | — | 127.0.0.1 | Webhook 服务器绑定地址 |
FEISHU_WEBHOOK_PORT | — | 8765 | Webhook 服务器端口 |
FEISHU_WEBHOOK_PATH | — | /feishu/webhook | Webhook 端点路径 |
HERMES_FEISHU_DEDUP_CACHE_SIZE | — | 2048 | 最大跟踪的去重消息 ID 数量 |
HERMES_FEISHU_TEXT_BATCH_DELAY_SECONDS | — | 0.6 | 文本突发防抖静默期 |
HERMES_FEISHU_TEXT_BATCH_MAX_MESSAGES | — | 8 | 每批文本合并的最大消息数 |
HERMES_FEISHU_TEXT_BATCH_MAX_CHARS | — | 4000 | 每批文本合并的最大字符数 |
HERMES_FEISHU_MEDIA_BATCH_DELAY_SECONDS | — | 0.8 | 媒体突发防抖静默期 |
WebSocket 和按群组访问控制设置通过 config.yaml 的 platforms.feishu.extra 配置(详见上方的 WebSocket 调优 和 按群组访问控制)。
故障排除
| 问题 | 解决方法 |
|---|---|
lark-oapi not installed | 安装 SDK:pip install lark-oapi |
websockets not installed; websocket mode unavailable | 安装 websockets:pip install websockets |
aiohttp not installed; webhook mode unavailable | 安装 aiohttp:pip install aiohttp |
FEISHU_APP_ID or FEISHU_APP_SECRET not set | 设置两个环境变量,或通过 hermes gateway setup 配置 |
Another local Hermes gateway is already using this Feishu app_id | 同一时间只有一个 Hermes 实例可使用同一 app_id。请先停止另一个网关。 |
| 机器人在群组中不响应 | 确保机器人被 @提及,检查 FEISHU_GROUP_POLICY,若策略为 allowlist 则确认发送者在 FEISHU_ALLOWED_USERS 中 |
Webhook rejected: invalid verification token | 确保 FEISHU_VERIFICATION_TOKEN 与飞书应用事件订阅配置中的令牌匹配 |
Webhook rejected: invalid signature | 确保 FEISHU_ENCRYPT_KEY 与飞书应用配置中的加密密钥匹配 |
| 帖子消息显示为纯文本 | 飞书 API 拒绝了帖子载荷,这是正常的降级行为。检查日志获取详情。 |
| 机器人未收到图片/文件 | 授予飞书应用 im:message 和 im:resource 权限范围 |
| 机器人身份未自动检测 | 通常是访问飞书机器人信息端点时的瞬时网络问题。作为临时解决方案,手动设置 FEISHU_BOT_OPEN_ID 和 FEISHU_BOT_NAME。 |
启用 FEISHU_ALLOW_BOTS 后对等机器人消息仍被忽略 | Hermes 尚无法识别自身——设置 FEISHU_BOT_OPEN_ID(若应用使用 sender_id_type=user_id 则还需设置 FEISHU_BOT_USER_ID)。 |
对等机器人显示为 ou_xxxxxx 而非名称 | 授予 application:bot.basic_info:read 权限范围。 |
| 点击审批按钮时出现错误 200340 | 在飞书开发者控制台启用交互式卡片能力并配置卡片请求 URL。详见上方的飞书应用配置要求。 |
Webhook rate limit exceeded | 同一 IP 每分钟超过 120 个请求。通常是配置错误或循环导致。 |
工具集
飞书 / Lark 使用 hermes-feishu 平台预设,包含与 Telegram 和其他基于网关的消息平台相同的核心工具。