Skip to content

Google Chat (Chat API)

状态:通过 Google Chat API webhooks(仅 HTTP)支持私信和空间。

快速设置(入门)

  1. 创建 Google Cloud 项目并启用 Google Chat API
  2. 创建服务账号:
    • 点击创建凭据 > 服务账号
    • 随意命名(例如 openclaw-chat)。
    • 权限留空(点击继续)。
    • 有权访问的主账号留空(点击完成)。
  3. 创建并下载 JSON 密钥:
    • 在服务账号列表中,点击刚创建的账号。
    • 转到 Keys 标签页。
    • 点击 Add Key > Create new key
    • 选择 JSON 并点击 Create
  4. 将下载的 JSON 文件存储在网关主机上(例如 ~/.openclaw/googlechat-service-account.json)。
  5. Google Cloud Console Chat Configuration 中创建 Google Chat 应用:
    • 填写 Application info:
      • App name:(例如 OpenClaw)
      • Avatar URL:(例如 https://openclaw.ai/logo.png)
      • Description:(例如 Personal AI Assistant)
    • 启用 Interactive features
    • Functionality 下,勾选 Join spaces and group conversations
    • Connection settings 下,选择 HTTP endpoint URL
    • Triggers 下,选择 Use a common HTTP endpoint URL for all triggers 并将其设置为您网关的公共 URL 加上 /googlechat
      • 提示:运行 openclaw status 查找您网关的公共 URL。
    • Visibility 下,勾选 Make this Chat app available to specific people and groups in <Your Domain>
    • 在文本框中输入您的电子邮件地址(例如 user@example.com)。
    • 点击底部的 Save
  6. 启用应用状态:
    • 保存后,刷新页面
    • 查找 App status 部分(通常在保存后的顶部或底部附近)。
    • 将状态更改为 Live - available to users
    • 再次点击 Save
  7. 使用服务账号路径 + webhook audience 配置 OpenClaw:
    • 环境变量:GOOGLE_CHAT_SERVICE_ACCOUNT_FILE=/path/to/service-account.json
    • 或配置:channels.googlechat.serviceAccountFile: "/path/to/service-account.json"
  8. 设置 webhook audience 类型 + 值(与您的 Chat 应用配置匹配)。
  9. 启动网关。Google Chat 将向您的 webhook 路径发送 POST 请求。

添加到 Google Chat

网关运行且您的电子邮件已添加到可见性列表后:

  1. 前往 Google Chat
  2. 点击 Direct Messages 旁边的 +(加号)图标。
  3. 在搜索栏(通常添加人员的地方)中,输入您在 Google Cloud Console 中配置的 App name
    • 注意:该机器人_不会_出现在"Marketplace"浏览列表中,因为它是私有应用。您必须按名称搜索它。
  4. 从结果中选择您的机器人。
  5. 点击 AddChat 开始一对一对话。
  6. 发送"Hello"触发助手!

公共 URL(仅 Webhook)

Google Chat webhooks 需要公共 HTTPS 端点。出于安全考虑,仅将 /googlechat 路径暴露到互联网。将 OpenClaw 仪表板和其他敏感端点保留在您的私有网络中。

选项 A:Tailscale Funnel(推荐)

对私有仪表板使用 Tailscale Serve,对公共 webhook 路径使用 Funnel。这样可以保持 / 私有,同时仅暴露 /googlechat

  1. 检查网关绑定的地址:

    bash
    ss -tlnp | grep 18789

    记下 IP 地址(例如 127.0.0.10.0.0.0 或您的 Tailscale IP,如 100.x.x.x)。

  2. 仅将仪表板暴露给 tailnet(端口 8443):

    bash
    # If bound to localhost (127.0.0.1 or 0.0.0.0):
    tailscale serve --bg --https 8443 http://127.0.0.1:18789
    
    # If bound to Tailscale IP only (e.g., 100.106.161.80):
    tailscale serve --bg --https 8443 http://100.106.161.80:18789
  3. 仅公开暴露 webhook 路径:

    bash
    # If bound to localhost (127.0.0.1 or 0.0.0.0):
    tailscale funnel --bg --set-path /googlechat http://127.0.0.1:18789/googlechat
    
    # If bound to Tailscale IP only (e.g., 100.106.161.80):
    tailscale funnel --bg --set-path /googlechat http://100.106.161.80:18789/googlechat
  4. 授权节点访问 Funnel: 如果提示,访问输出中显示的授权 URL,以在您的 tailnet 策略中为该节点启用 Funnel。

  5. 验证配置:

    bash
    tailscale serve status
    tailscale funnel status

您的公共 webhook URL 将是: https://<node-name>.<tailnet>.ts.net/googlechat

您的私有仪表板仅限 tailnet: https://<node-name>.<tailnet>.ts.net:8443/

在 Google Chat 应用配置中使用公共 URL(不带 :8443)。

注意:此配置在重启后保持。要稍后删除它,运行 tailscale funnel resettailscale serve reset

选项 B:反向代理(Caddy)

如果使用像 Caddy 这样的反向代理,仅代理特定路径:

caddy
your-domain.com {
    reverse_proxy /googlechat* localhost:18789
}

使用此配置,对 your-domain.com/ 的任何请求将被忽略或返回 404,而 your-domain.com/googlechat 安全地路由到 OpenClaw。

选项 C:Cloudflare Tunnel

配置隧道的入口规则以仅路由 webhook 路径:

  • Path:/googlechat -> http://localhost:18789/googlechat
  • Default Rule:HTTP 404(未找到)

工作原理

  1. Google Chat 向网关发送 webhook POST 请求。每个请求都包含一个 Authorization: Bearer <token> 标头。
  2. OpenClaw 根据配置的 audienceType + audience 验证令牌:
    • audienceType: "app-url" → audience 是您的 HTTPS webhook URL。
    • audienceType: "project-number" → audience 是 Cloud 项目编号。
  3. 消息按空间路由:
    • 私信使用会话密钥 agent:<agentId>:googlechat:dm:<spaceId>
    • 空间使用会话密钥 agent:<agentId>:googlechat:group:<spaceId>
  4. 私信访问默认需要配对。未知发送者会收到配对代码;使用以下方式批准:
    • openclaw pairing approve googlechat <code>
  5. 群组空间默认需要 @-提及。如果提及检测需要应用的用户名,使用 botUser

目标

使用这些标识符进行投递和允许列表:

  • 私信:users/<userId>users/<email>(接受电子邮件地址)。
  • 空间:spaces/<spaceId>

配置要点

json5
{
  channels: {
    googlechat: {
      enabled: true,
      serviceAccountFile: "/path/to/service-account.json",
      audienceType: "app-url",
      audience: "https://gateway.example.com/googlechat",
      webhookPath: "/googlechat",
      botUser: "users/1234567890", // optional; helps mention detection
      dm: {
        policy: "pairing",
        allowFrom: ["users/1234567890", "name@example.com"],
      },
      groupPolicy: "allowlist",
      groups: {
        "spaces/AAAA": {
          allow: true,
          requireMention: true,
          users: ["users/1234567890"],
          systemPrompt: "Short answers only.",
        },
      },
      actions: { reactions: true },
      typingIndicator: "message",
      mediaMaxMb: 20,
    },
  },
}

注意:

  • 服务账号凭据也可以使用 serviceAccount(JSON 字符串)内联传递。
  • 如果未设置 webhookPath,默认 webhook 路径为 /googlechat
  • actions.reactions 启用时,可通过 reactions 工具和 channels action 使用表情回应。
  • typingIndicator 支持 nonemessage(默认)和 reaction(表情回应需要用户 OAuth)。
  • 附件通过 Chat API 下载并存储在媒体管道中(大小受 mediaMaxMb 限制)。

故障排除

405 Method Not Allowed

如果 Google Cloud Logs Explorer 显示类似错误:

status code: 405, reason phrase: HTTP error response: HTTP/1.1 405 Method Not Allowed

这意味着 webhook 处理程序未注册。常见原因:

  1. 未配置频道:配置中缺少 channels.googlechat 部分。验证方法:

    bash
    openclaw config get channels.googlechat

    如果返回"Config path not found",添加配置(参见 配置要点)。

  2. 未启用插件:检查插件状态:

    bash
    openclaw plugins list | grep googlechat

    如果显示"disabled",在配置中添加 plugins.entries.googlechat.enabled: true

  3. 网关未重启:添加配置后,重启网关:

    bash
    openclaw gateway restart

验证频道是否运行:

bash
openclaw channels status
# Should show: Google Chat default: enabled, configured, ...

其他问题

  • 检查 openclaw channels status --probe 以查找身份验证错误或缺少 audience 配置。
  • 如果没有消息到达,确认 Chat 应用的 webhook URL + 事件订阅。
  • 如果提及限制阻止回复,将 botUser 设置为应用的用户资源名称,并验证 requireMention
  • 在发送测试消息时使用 openclaw logs --follow 查看请求是否到达网关。

相关文档: