Google Chat (Chat API)
状态:已支持通过 Google Chat API webhook(仅限 HTTP)进行私信和群组对话。快速设置(入门)
- 创建一个 Google Cloud 项目并启用 Google Chat API。
- 前往:Google Chat API Credentials
- 如果尚未启用 API,请启用它。
- 创建一个 Service Account:
- 点击 Create Credentials > Service Account。
- 随意命名(例如,
openclaw-chat)。 - 将权限留空(点击 Continue)。
- 将有访问权限的主体留空(点击 Done)。
- 创建并下载 JSON Key:
- 在服务帐号列表中,点击您刚刚创建的那个。
- 转到 Keys 标签页。
- 点击 Add Key > Create new key。
- 选择 JSON 并点击 Create。
- 将下载的 JSON 文件存储在您的网关主机上(例如,
~/.openclaw/googlechat-service-account.json)。 - 在 Google Cloud Console Chat Configuration 中创建一个 Google Chat 应用:
- 填写 Application info:
- App name:(例如
OpenClaw) - Avatar URL:(例如
https://openclaw.ai/logo.png) - Description:(例如
Personal AI Assistant)
- App name:(例如
- 启用 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。
- 填写 Application info:
- 启用应用状态:
- 保存后,刷新页面。
- 查找 App status 部分(通常在保存后位于顶部或底部附近)。
- 将状态更改为 Live - available to users。
- 再次点击 Save。
- 使用服务帐号路径 + webhook 受众配置 OpenClaw:
- Env:
GOOGLE_CHAT_SERVICE_ACCOUNT_FILE=/path/to/service-account.json - 或配置:
channels.googlechat.serviceAccountFile: "/path/to/service-account.json"。
- Env:
- 设置 webhook 受众类型和值(需与您的 Chat 应用配置匹配)。
- 启动网关。Google Chat 将向您的 webhook 路径发送 POST 请求。
添加到 Google Chat
网关运行且您的电子邮件已添加到可见性列表后:- 前往 Google Chat。
- 点击 Direct Messages 旁边的 +(加号)图标。
- 在搜索栏(通常用于添加人员的地方)中,输入您在 Google Cloud Console 中配置的 App name。
- 注意:机器人不会出现在“Marketplace”浏览列表中,因为它是私人应用。您必须按名称搜索。
- 从结果中选择您的机器人。
- 点击 Add 或 Chat 以开始 1:1 对话。
- 发送“Hello”以触发助手!
公开 URL(仅限 Webhook)
Google Chat webhook 需要一个公共 HTTPS 端点。出于安全考虑,仅将/googlechat 路径暴露到互联网。请将 OpenClaw 仪表盘和其他敏感端点保留在您的私有网络中。
选项 A:Tailscale Funnel(推荐)
使用 Tailscale Serve 托管私有仪表盘,并使用 Funnel 处理公共 webhook 路径。这可以在保持/ 私有的同时,仅暴露 /googlechat。
-
检查您的网关绑定到的地址:
记录 IP 地址(例如
127.0.0.1、0.0.0.0或您的 Tailscale IP,如100.x.x.x)。 -
仅向 tailnet 公开仪表板(端口 8443):
-
仅公开 webhook 路径:
- 授权节点进行 Funnel 访问: 如果出现提示,请访问输出中显示的授权 URL,以在您的 tailnet 策略中为此节点启用 Funnel。
-
验证配置:
https://<node-name>.<tailnet>.ts.net/googlechat
您的私有仪表板将仅限 tailnet 访问:
https://<node-name>.<tailnet>.ts.net:8443/
在 Google Chat 应用配置中使用公开 URL(不含 :8443)。
注意:此配置在重启后仍然有效。若要稍后将其移除,请运行tailscale funnel reset和tailscale serve reset。
选项 B:反向代理 (Caddy)
如果您使用像 Caddy 这样的反向代理,请仅代理特定路径:your-domain.com/ 的请求都将被忽略或返回 404,而 your-domain.com/googlechat 则会被安全地路由到 OpenClaw。
选项 C:Cloudflare Tunnel
配置您的隧道入口规则以仅路由 webhook 路径:- 路径:
/googlechat->http://localhost:18789/googlechat - 默认规则:HTTP 404 (未找到)
工作原理
- Google Chat 向网关发送 webhook POST 请求。每个请求都包含一个
Authorization: Bearer <token>请求头。- 当存在该请求头时,OpenClaw 会在读取/解析完整的 webhook 主体之前验证 bearer 身份验证。
- 通过更严格的预身份验证主体预算,支持在正文中携带
authorizationEventObject.systemIdToken的 Google Workspace 插件请求。
- OpenClaw 会根据配置的
audienceType+audience验证令牌:audienceType: "app-url"→ 受众是您的 HTTPS webhook URL。audienceType: "project-number"→ 受众是 Cloud 项目编号。
- 消息按空间路由:
- 私信使用会话密钥
agent:<agentId>:googlechat:direct:<spaceId>。 - 群组空间使用会话密钥
agent:<agentId>:googlechat:group:<spaceId>。
- 私信使用会话密钥
- 私信访问默认为配对模式。未知发送者会收到配对码;通过以下方式批准:
openclaw pairing approve googlechat <code>
- 群组空间默认需要 @提及。如果提及检测需要应用的用户名,请使用
botUser。
目标对象
使用这些标识符进行投递和允许列表匹配:- 私信:
users/<userId>(推荐)。 - 原始电子邮件
name@example.com是可变的,仅当channels.googlechat.dangerouslyAllowNameMatching: true时用于直接允许列表匹配。 - 已弃用:
users/<email>被视为用户 ID,而不是电子邮件允许列表。 - 聊天室:
spaces/<spaceId>。
配置要点
- 服务账号凭证也可以通过
serviceAccount内联传递(JSON 字符串)。 serviceAccountRef也受支持(环境变量/文件 SecretRef),包括channels.googlechat.accounts.<id>.serviceAccountRef下的每个账号引用。- 如果未设置
webhookPath,默认的 Webhook 路径为/googlechat。 dangerouslyAllowNameMatching为允许列表重新启用了可变邮箱主体匹配(紧急情况兼容模式)。- 当启用
actions.reactions时,可以通过reactions工具和channels action使用回应(反应)功能。 typingIndicator支持none、message(默认)和reaction(回应需要用户 OAuth)。- 附件通过 Chat API 下载并存储在媒体管道中(大小由
mediaMaxMb限制)。
故障排除
405 Method Not Allowed
如果 Google Cloud 日志资源管理器显示如下错误:-
未配置渠道:您的配置中缺少
channels.googlechat部分。通过以下命令验证:如果返回“Config path not found”,请添加配置(参见 配置要点)。 -
未启用插件:检查插件状态:
如果显示“disabled”,请将
plugins.entries.googlechat.enabled: true添加到您的配置中。 -
Gateway(网关) 未重启:添加配置后,请重启网关:
其他问题
- 检查
openclaw channels status --probe中是否存在身份验证错误或缺少受众群体配置。 - 如果没有收到消息,请确认 Chat 应用的 Webhook URL 和事件订阅。
- 如果提及(mention)拦截阻止了回复,请将
botUser设置为应用的用户资源名称,并验证requireMention。 - 发送测试消息时请使用
openclaw logs --follow,以查看请求是否到达网关。
本页面源自 openclaw/openclaw,由 BeaversLab 翻译,遵循 MIT 协议 发布。