WhatsApp (web channel)

状态：仅通过 Baileys 支持 WhatsApp Web。网关（Gateway）拥有会话。

快速设置（初学者）

  1. 如果可能，使用单独的电话号码（推荐）。
  2. 在 ~/.openclaw/openclaw.json 中配置 WhatsApp。
  3. 运行 openclaw channels login 扫描二维码（已关联的设备 Linked Devices）。
  4. 启动网关。

最小配置：

{
  channels: {
    whatsapp: {
      dmPolicy: "allowlist",
      allowFrom: ["+15551234567"]
    }
  }
}

目标

  • 在一个网关进程中支持多个 WhatsApp 账户（多账户 multi-account）。
  • 确定性路由（deterministic routing）：回复返回到 WhatsApp，无模型路由。
  • 模型看到足够的上下文以理解引用回复。

配置写入（Config writes）

默认情况下，WhatsApp 允许写入由 /config set|unset 触发的配置更新（需要 commands.config: true）。

禁用：

{
  channels: { whatsapp: { configWrites: false } }
}

架构（谁拥有什么）

  • **网关（Gateway）**拥有 Baileys socket 和收件箱循环。
  • CLI / macOS 应用与网关对话；不直接使用 Baileys。
  • 出站发送需要活动监听器；否则发送快速失败。

获取电话号码（两种模式）

WhatsApp 需要真实的手机号码进行验证。VoIP 和虚拟号码通常被阻止。有两种支持的运行 OpenClaw on WhatsApp 的方式：

专用号码（推荐）

为 OpenClaw 使用单独的电话号码。最佳用户体验，干净的路由，无自聊天怪癖。理想设置：备用/旧 Android 手机 + eSIM。保持它连接 Wi‑Fi 和电源，并通过二维码链接。

WhatsApp Business： 你可以在同一设备上使用不同号码的 WhatsApp Business。非常适合将个人 WhatsApp 分开 — 安装 WhatsApp Business 并在那里注册 OpenClaw 号码。

示例配置（专用号码，单用户允许列表）：

{
  channels: {
    whatsapp: {
      dmPolicy: "allowlist",
      allowFrom: ["+15551234567"]
    }
  }
}

配对模式（可选）： 如果你想要配对而不是允许列表，设置 channels.whatsapp.dmPolicy 为 pairing。未知发送者获得配对代码；批准： openclaw pairing approve whatsapp <code>

个人号码（回退）

快速回退：在你自己的号码上运行 OpenClaw。给自己发消息（WhatsApp "给自己发消息"）进行测试，这样你就不会垃圾联系人。期望在设置和实验期间在主手机上读取验证码。必须启用自聊天模式。 当向导询问你的个人 WhatsApp 号码时，输入你将发送消息的电话（所有者/发送者），而不是助手号码。

示例配置（个人号码，自聊天）：

{
  "whatsapp": {
    "selfChatMode": true,
    "dmPolicy": "allowlist",
    "allowFrom": ["+15551234567"]
  }
}

自聊天回复默认为 [{identity.name}]（如果设置）（否则 [openclaw]），如果 messages.responsePrefix 未设置。明确设置它以自定义或禁用前缀（使用 "" 删除它）。

号码采购技巧

  • 来自你所在国家移动运营商的本地 eSIM（最可靠）
  • 预付费 SIM — 便宜，只需接收一条验证短信

避免： TextNow、Google Voice、大多数"免费 SMS"服务 — WhatsApp 积极阻止这些。

提示： 号码只需接收一条验证短信。之后，WhatsApp Web 会话通过 creds.json 持久化。

为什么不用 Twilio？

  • 早期的 OpenClaw 构建支持 Twilio 的 WhatsApp Business 集成。
  • WhatsApp Business 号码不适合个人助手。
  • Meta 强制执行 24 小时回复窗口；如果你在过去 24 小时内没有回复，商业号码无法发起新消息。
  • 大量或"健谈"的使用会触发积极的阻止，因为商业账户不打算发送数十条个人助手消息。
  • 结果：传递不可靠且经常被阻止，因此支持被删除。

登录 + 凭据

  • 登录命令：openclaw channels login（通过已关联设备的二维码）。
  • 多账户登录：openclaw channels login --account <id>（<id> = accountId）。
  • 默认账户（当省略 --account 时）：如果存在 default，否则第一个配置的账户 ID（已排序）。
  • 凭据存储在 ~/.openclaw/credentials/whatsapp/<accountId>/creds.json 中。
  • 备份副本位于 creds.json.bak（在损坏时恢复）。
  • 旧版兼容性：较旧的安装直接将 Baileys 文件存储在 ~/.openclaw/credentials/ 中。
  • 登出：openclaw channels logout（或 --account <id>）删除 WhatsApp 认证状态（但保留共享的 oauth.json）。
  • 已登出的 socket => 错误指示重新链接。

入站流（私信 + 群组）

  • WhatsApp 事件来自 messages.upsert（Baileys）。
  • 收件箱监听器在关闭时分离，以避免在测试/重启中累积事件处理程序。
  • 状态/广播聊天被忽略。
  • 直接聊天使用 E.164；群组使用群组 JID。
  • 私信策略：channels.whatsapp.dmPolicy 控制直接聊天访问（默认：pairing）。
    • 配对：未知发送者获得配对代码（通过 openclaw pairing approve whatsapp <code> 批准；代码 1 小时后过期）。
    • 开放：需要 channels.whatsapp.allowFrom 包含 "*"。
    • 你关联的 WhatsApp 号码被隐式信任，因此自我消息跳过 channels.whatsapp.dmPolicy 和 channels.whatsapp.allowFrom 检查。

个人号码模式（回退）

如果你在个人 WhatsApp 号码上运行 OpenClaw，启用 channels.whatsapp.selfChatMode（参见上面的示例）。

行为：

  • 出站私信永不触发配对回复（防止垃圾联系人）。
  • 入站未知发送者仍遵循 channels.whatsapp.dmPolicy。
  • 自聊天模式（allowFrom 包含你的号码）避免自动已读回执并忽略提及 JID。
  • 为非自聊天私信发送已读回执。

已读回执（Read receipts）

默认情况下，一旦接受入站 WhatsApp 消息，网关会将其标记为已读（蓝色勾号）。

全局禁用：

{
  channels: { whatsapp: { sendReadReceipts: false } }
}

每账户禁用：

{
  channels: {
    whatsapp: {
      accounts: {
        personal: { sendReadReceipts: false }
      }
    }
  }
}

注意：

  • 自聊天模式始终跳过已读回执。

WhatsApp 常见问题：发送消息 + 配对

当我链接 WhatsApp 时，OpenClaw 会给随机联系人发消息吗？
不会。默认私信策略是配对，因此未知发送者只会获得配对代码，他们的消息不会被处理。OpenClaw 只回复它收到的聊天，或你明确触发的发送（代理/CLI）。

WhatsApp 上的配对如何工作？
配对是未知发送者的私信门：

  • 来自新发送者的第一条私信返回短代码（消息未处理）。
  • 批准：openclaw pairing approve whatsapp <code>（列表：openclaw pairing list whatsapp）。
  • 代码 1 小时后过期；待处理请求限制为每个频道 3 个。

多人可以在一个 WhatsApp 号码上使用不同的 OpenClaw 实例吗？
可以，通过 bindings 将每个发送者路由到不同的代理（对等 kind: "dm"，发送者 E.164 如 +15551234567）。回复仍来自相同的 WhatsApp 账户，直接聊天折叠到每个代理的主会话，因此每人使用一个代理。私信访问控制（dmPolicy/allowFrom）对每个 WhatsApp 账户是全局的。参见多代理路由（Multi-Agent Routing）。

你为什么在向导中询问我的电话号码？
向导使用它来设置你的允许列表/所有者，以便允许你自己的私信。它不用于自动发送。如果你在个人 WhatsApp 号码上运行，使用相同的号码并启用 channels.whatsapp.selfChatMode。

消息规范化（模型看到什么）

  • Body 是带信封的当前消息正文。
  • 引用回复上下文始终附加： 
    [Replying to +1555 id:ABC123]
<quoted text or <media:...>>
[/Replying]
  • 回复元数据也设置：
    • ReplyToId = stanzaId
    • ReplyToBody = 引用正文或媒体占位符
    • ReplyToSender = E.164（已知时）
  • 仅媒体的入站消息使用占位符：
    • <media:image|video|audio|document|sticker>

群组

  • 群组映射到 agent:<agentId>:whatsapp:group:<jid> 会话。
  • 群组策略：channels.whatsapp.groupPolicy = open|disabled|allowlist（默认 allowlist）。
  • 激活模式：
    • mention（默认）：需要 @mention 或正则匹配。
    • always：始终触发。
  • /activation mention|always 仅限所有者，必须作为独立消息发送。
  • 所有者 = channels.whatsapp.allowFrom（或未设置时的自我 E.164）。
  • 历史注入（仅待处理）：
    • 最近的未处理消息（默认 50）插入到： [Chat messages since your last reply - for context]（已在会话中的消息不会重新注入）
    • 当前消息在： [Current message - respond to this]
    • 附加发送者后缀：[from: Name (+E164)]
  • 群组元数据缓存 5 分钟（主题 + 参与者）。

回复传递（线程）

  • WhatsApp Web 发送标准消息（当前网关中无引用回复线程）。
  • 回复标签在此频道上被忽略。

确认反应（收到时自动反应 Acknowledgment reactions）

WhatsApp 可以在收到传入消息后立即自动发送表情符号反应，在机器人生成回复之前。这为用户提供即时反馈，表明他们的消息已收到。

配置：

{
  "whatsapp": {
    "ackReaction": {
      "emoji": "👀",
      "direct": true,
      "group": "mentions"
    }
  }
}

选项：

  • emoji（字符串）：用于确认的表情符号（例如，"👀"、"✅"、"📨"）。空或省略 = 功能禁用。
  • direct（布尔值，默认：true）：在直接/私信聊天中发送反应。
  • group（字符串，默认："mentions"）：群聊行为：
    • "always"：对所有群组消息做出反应（即使没有 @mention）
    • "mentions"：仅在机器人被 @mentioned 时做出反应
    • "never"：从不在群组中做出反应

每账户覆盖：

{
  "whatsapp": {
    "accounts": {
      "work": {
        "ackReaction": {
          "emoji": "✅",
          "direct": false,
          "group": "always"
        }
      }
    }
  }
}

行为说明：

  • 反应在消息收到后立即发送，在输入指示器或机器人回复之前。
  • 在 requireMention: false（激活：always）的群组中，group: "mentions" 将对所有消息做出反应（不仅仅是 @mentions）。
  • 即发即忘（Fire-and-forget）：反应失败被记录但不会阻止机器人回复。
  • 群组反应自动包含参与者 JID。
  • WhatsApp 忽略 messages.ackReaction；使用 channels.whatsapp.ackReaction 代替。

代理工具（反应）

  • 工具：whatsapp 带 react 操作（chatJid、messageId、emoji、可选 remove）。
  • 可选：participant（群组发送者）、fromMe（对你自己的消息做出反应）、accountId（多账户）。
  • 反应移除语义：参见 /tools/reactions。
  • 工具门控：channels.whatsapp.actions.reactions（默认：启用）。

限制

  • 出站文本被分块为 channels.whatsapp.textChunkLimit（默认 4000）。
  • 可选的换行符分块：设置 channels.whatsapp.chunkMode="newline" 在长度分块前按空行（段落边界）分割。
  • 入站媒体保存受 channels.whatsapp.mediaMaxMb 限制（默认 50 MB）。
  • 出站媒体项受 agents.defaults.mediaMaxMb 限制（默认 5 MB）。

出站发送（文本 + 媒体）

  • 使用活动 web 监听器；如果网关未运行则错误。
  • 文本分块：每条消息最大 4k（通过 channels.whatsapp.textChunkLimit 可配置，可选 channels.whatsapp.chunkMode）。
  • 媒体：
    • 支持图像/视频/音频/文档。
    • 音频作为 PTT 发送；audio/ogg => audio/ogg; codecs=opus。
    • 仅在第一个媒体项上显示标题。
    • 媒体获取支持 HTTP(S) 和本地路径。
    • 动画 GIF：WhatsApp 期望 MP4 与 gifPlayback: true 进行内联循环。
      • CLI：openclaw message send --media <mp4> --gif-playback
      • 网关：send 参数包含 gifPlayback: true

语音笔记（PTT 音频）

WhatsApp 将音频作为语音笔记（PTT 气泡）发送。

  • 最佳结果：OGG/Opus。OpenClaw 将 audio/ogg 重写为 audio/ogg; codecs=opus。
  • [[audio_as_voice]] 对 WhatsApp 被忽略（音频已作为语音笔记发送）。

媒体限制 + 优化

  • 默认出站上限：5 MB（每个媒体项）。
  • 覆盖：agents.defaults.mediaMaxMb。
  • 图像在上限下自动优化为 JPEG（调整大小 + 质量扫描）。
  • 超大媒体 => 错误；媒体回复回退到文本警告。

心跳（Heartbeats）

  • 网关心跳记录连接健康（web.heartbeatSeconds，默认 60s）。
  • 代理心跳可以按代理配置（agents.list[].heartbeat）或全局通过 agents.defaults.heartbeat（未设置每代理条目时回退）。
    • 使用配置的心跳提示（默认：Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.）+ HEARTBEAT_OK 跳过行为。
    • 传递默认为最后使用的频道（或配置的目标）。

重新连接行为

  • 退避策略：web.reconnect：
    • initialMs、maxMs、factor、jitter、maxAttempts。
  • 如果达到 maxAttempts，web 监控停止（降级）。
  • 已登出 => 停止并需要重新链接。

配置快速映射

  • channels.whatsapp.dmPolicy（私信策略：pairing/allowlist/open/disabled）。
  • channels.whatsapp.selfChatMode（同一电话设置；机器人使用你的个人 WhatsApp 号码）。
  • channels.whatsapp.allowFrom（私信允许列表）。WhatsApp 使用 E.164 电话号码（无用户名）。
  • channels.whatsapp.mediaMaxMb（入站媒体保存上限）。
  • channels.whatsapp.ackReaction（消息收到时的自动反应：{emoji, direct, group}）。
  • channels.whatsapp.accounts.<accountId>.*（每账户设置 + 可选 authDir）。
  • channels.whatsapp.accounts.<accountId>.mediaMaxMb（每账户入站媒体上限）。
  • channels.whatsapp.accounts.<accountId>.ackReaction（每账户确认反应覆盖）。
  • channels.whatsapp.groupAllowFrom（群组发送者允许列表）。
  • channels.whatsapp.groupPolicy（群组策略）。
  • channels.whatsapp.historyLimit / channels.whatsapp.accounts.<accountId>.historyLimit（群组历史上下文；0 禁用）。
  • channels.whatsapp.dmHistoryLimit（私信历史限制，用户轮次）。每用户覆盖：channels.whatsapp.dms["<phone>"].historyLimit。
  • channels.whatsapp.groups（群组允许列表 + 提及门控默认值；使用 "*" 允许所有）
  • channels.whatsapp.actions.reactions（门控 WhatsApp 工具反应）。
  • agents.list[].groupChat.mentionPatterns（或 messages.groupChat.mentionPatterns）
  • messages.groupChat.historyLimit
  • channels.whatsapp.messagePrefix（入站前缀；每账户：channels.whatsapp.accounts.<accountId>.messagePrefix；已弃用：messages.messagePrefix）
  • messages.responsePrefix（出站前缀）
  • agents.defaults.mediaMaxMb
  • agents.defaults.heartbeat.every
  • agents.defaults.heartbeat.model（可选覆盖）
  • agents.defaults.heartbeat.target
  • agents.defaults.heartbeat.to
  • agents.defaults.heartbeat.session
  • agents.list[].heartbeat.*（每代理覆盖）
  • session.*（scope、idle、store、mainKey）
  • web.enabled（当 false 时禁用频道启动）
  • web.heartbeatSeconds
  • web.reconnect.*

日志 + 故障排除

故障排除（快速）

未链接 / 需要二维码登录

  • 症状：channels status 显示 linked: false 或警告"未链接（Not linked）"。
  • 修复：在网关主机上运行 openclaw channels login 并扫描二维码（WhatsApp → 设置 → 已关联的设备）。

已链接但断开连接 / 重新连接循环

  • 症状：channels status 显示 running, disconnected 或警告"已链接但断开连接（Linked but disconnected）"。
  • 修复：openclaw doctor（或重启网关）。如果仍然存在，通过 channels login 重新链接并检查 openclaw logs --follow。

Bun 运行时

  • 不推荐 Bun。WhatsApp（Baileys）和 Telegram 在 Bun 上不可靠。 使用 Node 运行网关。（参见入门运行时说明。）
← 返回文档首页