飞书机器人

飞书(Lark)是企业用于消息传递和协作的团队聊天平台。此插件让 OpenClaw 连接到飞书/钉钉机器人,使用平台的 WebSocket 事件订阅,这样可以在不公开 webhook URL 的情况下接收消息。


所需插件

安装飞书插件:

openclaw plugins install @openclaw/feishu

本地检出(从 git 仓库运行时):

openclaw plugins install ./extensions/feishu

快速开始

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

方法 1:入门向导(推荐)

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

openclaw onboard

向导会引导您:

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

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

  • openclaw gateway status
  • openclaw logs --follow

方法 2:CLI 设置

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

openclaw channels add

选择 飞书,然后输入 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",
      "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

选择 飞书 并粘贴您的 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",请设置 verificationToken。飞书 webhook 服务器默认绑定到 127.0.0.1;只有当您故意需要不同的绑定地址时才设置 webhookHost

通过环境变量配置

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",
        },
      },
    },
  },
}

步骤 3:启动 + 测试

1. 启动 gateway

openclaw gateway

2. 发送测试消息

在飞书中,找到您的机器人并发送消息。

3. 批准配对

默认情况下,机器人会回复配对代码。批准它:

openclaw pairing approve feishu <CODE>

批准后,您可以正常聊天。


概述

  • 飞书机器人通道:由 gateway 管理的飞书机器人
  • 确定性路由:回复始终返回飞书
  • 会话隔离:DM 共享主会话;群组是隔离的
  • 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",
      groupAllowFrom: ["ou_xxx", "ou_yyy"],
    },
  },
}

获取群组/用户 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 并 DM 机器人
  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: {
      accounts: {
        main: {
          appId: "cli_xxx",
          appSecret: "xxx",
          botName: "Primary bot",
        },
        backup: {
          appId: "cli_yyy",
          appSecret: "yyy",
          botName: "Backup bot",
          enabled: false,
        },
      },
    },
  },
}

消息限制

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

流式传输

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

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

设置 streaming: false 以在发送前等待完整回复。

多代理路由

使用 bindings 将飞书 DM 或群组路由到不同的代理。

{
  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.verificationTokenwebhook 模式需要-
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.dmPolicyDM 策略pairing
channels.feishu.allowFromDM 允许列表(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"仅允许列表中的用户可以聊天
"open"允许所有用户(需要在 allowFrom 中使用 "*"
"disabled"禁用 DM

支持的消息类型

接收

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

发送

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