飞书机器人

飞书(Lark)是一个企业团队聊天与协作平台。此插件通过飞书/Lark 的 WebSocket 事件订阅将 OpenClaw 连接到飞书机器人,无需暴露公网 webhook URL 即可接收消息。


内置插件

当前版本的 OpenClaw 已内置飞书支持,无需额外安装插件。

如果你使用的是较旧版本或未包含内置飞书支持的自定义安装,请手动安装:

openclaw plugins install @openclaw/feishu

快速开始

添加飞书频道有两种方式:

方式 1:引导向导(推荐)

如果你刚安装 OpenClaw,运行向导:

openclaw onboard

向导会引导你完成:

  1. 创建飞书应用并收集凭据
  2. 在 OpenClaw 中配置应用凭据
  3. 启动 Gateway

配置完成后,检查 Gateway 状态:

  • openclaw gateway status
  • openclaw logs --follow

方式 2:CLI 设置

如果你已完成初始安装,通过 CLI 添加频道:

openclaw channels add

选择 Feishu,然后输入 App ID 和 App Secret。

配置完成后,管理 Gateway:

  • openclaw gateway status
  • openclaw gateway restart
  • openclaw logs --follow

步骤 1:创建飞书应用

1. 打开飞书开放平台

访问飞书开放平台并登录。

Lark(国际版)租户请使用 https://open.larksuite.com/app,并在飞书配置中设置 domain: "lark"

2. 创建应用

  1. 点击创建企业自建应用
  2. 填写应用名称和描述
  3. 选择应用图标

创建企业自建应用

3. 复制凭据

凭证与基础信息中,复制:

  • App ID(格式:cli_xxx
  • App Secret

警告: 妥善保管 App Secret。

获取凭据

4. 配置权限

权限管理中,点击批量导入并粘贴:

{
  "scopes": {
    "tenant": [
      "aily:file:read",
      "aily:file:write",
      "application:application.app_message_stats.overview:readonly",
      "application:application:self_manage",
      "application:bot.menu:write",
      "cardkit:card:read",
      "cardkit:card:write",
      "contact:user.employee_id:readonly",
      "corehr:file:download",
      "event:ip_list",
      "im:chat.access_event.bot_p2p_chat:read",
      "im:chat.members:bot_access",
      "im:message",
      "im:message.group_at_msg:readonly",
      "im:message.p2p_msg:readonly",
      "im:message:readonly",
      "im:message:send_as_bot",
      "im:resource"
    ],
    "user": ["aily:file:read", "aily:file:write", "im:chat.access_event.bot_p2p_chat:read"]
  }
}

配置权限

5. 启用机器人能力

应用能力 > 机器人中:

  1. 启用机器人能力
  2. 设置机器人名称

启用机器人能力

6. 配置事件订阅

警告: 在设置事件订阅之前,请确保:

  1. 你已经运行了 openclaw channels add 配置飞书
  2. Gateway 正在运行(openclaw gateway status

事件订阅中:

  1. 选择使用长连接接收事件(WebSocket)
  2. 添加事件:im.message.receive_v1

警告: 如果 Gateway 未运行,长连接设置可能无法保存。

配置事件订阅

7. 发布应用

  1. 版本管理与发布中创建版本
  2. 提交审核并发布
  3. 等待管理员审批(企业应用通常自动审批)

步骤 2:配置 OpenClaw

使用向导配置(推荐)

openclaw channels add

选择 Feishu 并粘贴 App ID 和 App Secret。

通过配置文件配置

编辑 ~/.openclaw/openclaw.json

{
  channels: {
    feishu: {
      enabled: true,
      dmPolicy: "pairing",
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
          botName: "My AI assistant",
        },
      },
    },
  },
}

如果你使用 connectionMode: "webhook",需要同时设置 verificationTokenencryptKey。飞书 webhook 服务器默认绑定到 127.0.0.1;仅在确实需要不同绑定地址时才设置 webhookHost

Verification Token 和 Encrypt Key(webhook 模式)

使用 webhook 模式时,在配置中设置 channels.feishu.verificationTokenchannels.feishu.encryptKey。获取方式:

  1. 在飞书开放平台中打开你的应用
  2. 进入开发配置事件与回调
  3. 打开加密策略标签页
  4. 复制 Verification TokenEncrypt Key

下方截图展示了 Verification Token 的位置。Encrypt Key 位于同一加密策略部分。

Verification Token 位置

通过环境变量配置

export FEISHU_APP_ID="cli_xxx"
export FEISHU_APP_SECRET="xxx"

Lark(国际版)域名

如果你的租户使用 Lark(国际版),将域名设置为 lark(或完整域名字符串)。可以在 channels.feishu.domain 或按账户设置(channels.feishu.accounts.<id>.domain)。

{
  channels: {
    feishu: {
      domain: "lark",
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
        },
      },
    },
  },
}

配额优化选项

你可以通过两个可选标志减少飞书 API 调用量:

  • typingIndicator(默认 true):设为 false 时跳过输入反馈调用。
  • resolveSenderNames(默认 true):设为 false 时跳过发送者资料查询调用。

可在顶层或按账户设置:

{
  channels: {
    feishu: {
      typingIndicator: false,
      resolveSenderNames: false,
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
          typingIndicator: true,
          resolveSenderNames: false,
        },
      },
    },
  },
}

步骤 3:启动 + 测试

1. 启动 Gateway

openclaw gateway

2. 发送测试消息

在飞书中找到你的机器人,发送一条消息。

3. 批准配对

默认情况下,机器人会回复一个配对码。批准方式:

openclaw pairing approve feishu <CODE>

批准后即可正常聊天。


概览

  • 飞书机器人频道:由 Gateway 管理的飞书机器人
  • 确定性路由:回复始终返回飞书
  • 会话隔离:私信共享主会话;群组隔离
  • WebSocket 连接:通过飞书 SDK 长连接,无需公网 URL

访问控制

私信

  • 默认dmPolicy: "pairing"(未知用户收到配对码)

  • 批准配对

    openclaw pairing list feishu
    openclaw pairing approve feishu <CODE>
  • 白名单模式:设置 channels.feishu.allowFrom 填入允许的 Open ID

群组聊天

1. 群组策略channels.feishu.groupPolicy):

  • "open" = 群组中允许所有人(默认)
  • "allowlist" = 仅允许 groupAllowFrom 中的用户
  • "disabled" = 禁用群组消息

2. 提及要求channels.feishu.groups.<chat_id>.requireMention):

  • true = 需要 @提及(默认)
  • false = 无需提及即可回复

群组配置示例

允许所有群组,需要 @提及(默认)

{
  channels: {
    feishu: {
      groupPolicy: "open",
      // 默认 requireMention: true
    },
  },
}

允许所有群组,无需 @提及

{
  channels: {
    feishu: {
      groups: {
        oc_xxx: { requireMention: false },
      },
    },
  },
}

仅允许特定群组

{
  channels: {
    feishu: {
      groupPolicy: "allowlist",
      // 飞书群组 ID(chat_id)格式:oc_xxx
      groupAllowFrom: ["oc_xxx", "oc_yyy"],
    },
  },
}

限制群组中的发送者(发送者白名单)

除了允许群组本身外,该群组中的所有消息都受发送者 open_id 门控:只有在 groups.<chat_id>.allowFrom 中列出的用户的消息会被处理;其他成员的消息会被忽略(这是完整的发送者级门控,不仅限于 /reset 或 /new 等控制命令)。

{
  channels: {
    feishu: {
      groupPolicy: "allowlist",
      groupAllowFrom: ["oc_xxx"],
      groups: {
        oc_xxx: {
          // 飞书用户 ID(open_id)格式:ou_xxx
          allowFrom: ["ou_user1", "ou_user2"],
        },
      },
    },
  },
}

获取群组/用户 ID

群组 ID(chat_id)

群组 ID 格式为 oc_xxx

方式 1(推荐)

  1. 启动 Gateway 并在群组中 @提及机器人
  2. 运行 openclaw logs --follow 并查找 chat_id

方式 2

使用飞书 API 调试器列出群组聊天。

用户 ID(open_id)

用户 ID 格式为 ou_xxx

方式 1(推荐)

  1. 启动 Gateway 并向机器人发送私信
  2. 运行 openclaw logs --follow 并查找 open_id

方式 2

查看配对请求中的用户 Open ID:

openclaw pairing list feishu

常用命令

命令说明
/status显示机器人状态
/reset重置会话
/model显示/切换模型

注意: 飞书尚不支持原生命令菜单,因此命令必须以文本形式发送。

Gateway 管理命令

命令说明
openclaw gateway status显示 Gateway 状态
openclaw gateway install安装/启动 Gateway 服务
openclaw gateway stop停止 Gateway 服务
openclaw gateway restart重启 Gateway 服务
openclaw logs --follow实时查看 Gateway 日志

故障排查

机器人在群组中不回复

  1. 确保机器人已添加到群组
  2. 确保你 @提及了机器人(默认行为)
  3. 检查 groupPolicy 是否设为 "disabled"
  4. 查看日志:openclaw logs --follow

机器人收不到消息

  1. 确保应用已发布并通过审批
  2. 确保事件订阅包含 im.message.receive_v1
  3. 确保已启用长连接
  4. 确保应用权限完整
  5. 确保 Gateway 正在运行:openclaw gateway status
  6. 查看日志:openclaw logs --follow

App Secret 泄露

  1. 在飞书开放平台重置 App Secret
  2. 在配置中更新 App Secret
  3. 重启 Gateway

消息发送失败

  1. 确保应用拥有 im:message:send_as_bot 权限
  2. 确保应用已发布
  3. 查看日志获取详细错误信息

高级配置

多账户

{
  channels: {
    feishu: {
      defaultAccount: "main",
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
          botName: "Primary bot",
        },
        backup: {
          appId: "cli_yyy",
          appSecret: "yyy",
          botName: "Backup bot",
          enabled: false,
        },
      },
    },
  },
}

defaultAccount 控制出站 API 未显式指定 accountId 时使用哪个飞书账户。

消息限制

  • textChunkLimit:出站文本分块大小(默认:2000 字符)
  • mediaMaxMb:媒体上传/下载限制(默认:30MB)

流式传输

飞书支持通过交互卡片进行流式回复。启用后,机器人会在生成文本时实时更新卡片。

{
  channels: {
    feishu: {
      streaming: true, // 启用流式卡片输出(默认 true)
      blockStreaming: true, // 启用分块流式传输(默认 true)
    },
  },
}

设置 streaming: false 可在完整回复生成后再发送。

多 Agent 路由

使用 bindings 将飞书私信或群组路由到不同的 Agent。

{
  agents: {
    list: [
      { id: "main" },
      {
        id: "clawd-fan",
        workspace: "/home/user/clawd-fan",
        agentDir: "/home/user/.openclaw/agents/clawd-fan/agent",
      },
      {
        id: "clawd-xi",
        workspace: "/home/user/clawd-xi",
        agentDir: "/home/user/.openclaw/agents/clawd-xi/agent",
      },
    ],
  },
  bindings: [
    {
      agentId: "main",
      match: {
        channel: "feishu",
        peer: { kind: "direct", id: "ou_xxx" },
      },
    },
    {
      agentId: "clawd-fan",
      match: {
        channel: "feishu",
        peer: { kind: "direct", id: "ou_yyy" },
      },
    },
    {
      agentId: "clawd-xi",
      match: {
        channel: "feishu",
        peer: { kind: "group", id: "oc_zzz" },
      },
    },
  ],
}

路由字段:

  • match.channel"feishu"
  • match.peer.kind"direct""group"
  • match.peer.id:用户 Open ID(ou_xxx)或群组 ID(oc_xxx

查看获取群组/用户 ID了解查询方法。


配置参考

完整配置:Gateway 配置

重要选项:

设置说明默认值
channels.feishu.enabled启用/禁用频道true
channels.feishu.domainAPI 域名(feishularkfeishu
channels.feishu.connectionMode事件传输模式websocket
channels.feishu.defaultAccount出站路由的默认账户 IDdefault
channels.feishu.verificationTokenwebhook 模式必需-
channels.feishu.encryptKeywebhook 模式必需-
channels.feishu.webhookPathWebhook 路由路径/feishu/events
channels.feishu.webhookHostWebhook 绑定主机127.0.0.1
channels.feishu.webhookPortWebhook 绑定端口3000
channels.feishu.accounts.<id>.appIdApp ID-
channels.feishu.accounts.<id>.appSecretApp Secret-
channels.feishu.accounts.<id>.domain按账户 API 域名覆盖feishu
channels.feishu.dmPolicy私信策略pairing
channels.feishu.allowFrom私信白名单(open_id 列表)-
channels.feishu.groupPolicy群组策略open
channels.feishu.groupAllowFrom群组白名单-
channels.feishu.groups.<chat_id>.requireMention需要 @提及true
channels.feishu.groups.<chat_id>.enabled启用群组true
channels.feishu.textChunkLimit消息分块大小2000
channels.feishu.mediaMaxMb媒体大小限制30
channels.feishu.streaming启用流式卡片输出true
channels.feishu.blockStreaming启用分块流式传输true

dmPolicy 参考

行为
"pairing"默认。 未知用户收到配对码,需批准后才能使用
"allowlist"allowFrom 中的用户可以聊天
"open"允许所有用户(需要 allowFrom 中包含 "*"
"disabled"禁用私信

支持的消息类型

接收

  • 文本
  • 富文本(post)
  • 图片
  • 文件
  • 音频
  • 视频
  • 贴纸

发送

  • 文本
  • 图片
  • 文件
  • 音频
  • 富文本(部分支持)