Skip to content

WhatsApp(网页通道)

状态:仅通过 Baileys 使用 WhatsApp Web。网关拥有会话。

快速设置(初学者)

  1. 尽可能使用独立的手机号码(推荐)。
  2. ~/.clawdbot/openclaw.json 中配置 WhatsApp。
  3. 运行 openclaw channels login 扫描二维码(已关联的设备)。
  4. 启动网关。

最小配置:

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

目标

  • 在一个网关进程中支持多个 WhatsApp 账户(多账户)。
  • 确定性路由:回复返回 WhatsApp,无模型路由。
  • 模型看到足够的上下文以理解引用回复。

配置写入

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

禁用:

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

架构(谁拥有什么)

  • 网关拥有 Baileys 套接字和收件箱循环。
  • CLI / macOS 应用与网关通信;不直接使用 Baileys。
  • 需要活动监听器才能发送出站消息;否则发送快速失败。

获取手机号码(两种模式)

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

专用号码(推荐)

为 openclaw 使用独立的手机号码。最佳用户体验,干净的路由,无自聊天怪癖。理想设置:备用/旧 Android 手机 + eSIM。保持 Wi‑Fi 和电源连接,并通过二维码关联。

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

示例配置(专用号码,单用户白名单):

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

配对模式(可选): 如果您想要配对而不是白名单,请将 channels.whatsapp.dmPolicy 设置为 pairing。未知发送者会收到配对码;通过以下方式批准: openclaw pairing approve whatsapp <code>

个人号码(备用方案)

快速备用方案:在您自己的号码上运行 openclaw。给自己发消息(WhatsApp"给自己发消息")进行测试,以免打扰联系人。在设置和实验期间,请准备好从主手机上读取验证码。必须启用自聊天模式。 当向导询问您的个人 WhatsApp 号码时,请输入您将从中发送消息的手机号码(所有者/发送者),而不是助手号码。

示例配置(个人号码,自聊天):

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

messages.responsePrefix 未设置时,自聊天回复默认为 [{identity.name}](否则为 [openclaw])。显式设置它以自定义或禁用前缀(使用 "" 删除)。

号码获取技巧

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

避免: TextNow、Google Voice、大多数"免费短信"服务 — 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(排序后)。
  • 凭据存储在 ~/.clawdbot/credentials/whatsapp/<accountId>/creds.json
  • 备份副本位于 creds.json.bak(损坏时恢复)。
  • 旧版兼容性:旧安装将 Baileys 文件直接存储在 ~/.clawdbot/credentials/ 中。
  • 注销:openclaw channels logout(或 --account <id>)删除 WhatsApp 认证状态(但保留共享的 oauth.json)。
  • 已注销的套接字 => 错误指示重新关联。

Inbound flow (DM + group)

  • WhatsApp events come from messages.upsert (Baileys).
  • Inbox listeners are detached on shutdown to avoid accumulating event handlers in tests/restarts.
  • 状态/广播聊天被忽略。
  • 直接聊天使用 E.164;群组使用群组 JID。
  • 私信策略channels.whatsapp.dmPolicy 控制直接聊天访问(默认:pairing)。
    • 配对:未知发送者收到配对码(通过 openclaw pairing approve whatsapp <code> 批准;配对码在 1 小时后过期)。
    • 开放:需要 channels.whatsapp.allowFrom 包含 "*"
    • 自己的消息始终允许;"自聊天模式"仍需要 channels.whatsapp.allowFrom 包含您自己的号码。

个人号码模式(备用方案)

如果您在个人 WhatsApp 号码上运行 openclaw,请启用 channels.whatsapp.selfChatMode(见上文示例)。

行为:

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

已读回执

默认情况下,网关在 WhatsApp 消息被接受后将其标记为已读(蓝色勾号)。

全局禁用:

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

按账户禁用:

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

注意:

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

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

当我关联 WhatsApp 时,openclaw 会给随机联系人发消息吗?
不会。默认私信策略是配对,因此未知发送者只会收到配对码,他们的消息不会被处理。openclaw 只回复它接收到的聊天,或您显式触发的发送(代理/CLI)。

WhatsApp 上的配对如何工作?
配对是未知发送者的私信门控:

  • 来自新发送者的第一条私信返回一个短代码(消息不被处理)。
  • 通过以下方式批准:openclaw pairing approve whatsapp <code>(使用 openclaw pairing list whatsapp 列出)。
  • 配对码在 1 小时后过期;每个通道的待处理请求上限为 3 个。

多个用户可以在一个 WhatsApp 号码上使用不同的 openclaws 吗?
可以,通过 bindings 将每个发送者路由到不同的代理(对等方 kind: "dm",发送者 E.164 如 +15551234567)。回复仍来自同一个 WhatsApp 账户,直接聊天会折叠到每个代理的主会话,因此每人使用一个代理。私信访问控制(dmPolicy/allowFrom)是每个 WhatsApp 账户的全局设置。参见多代理路由

为什么向导中要询问我的手机号码?
向导使用它来设置您的白名单/所有者,以便您自己的私信被允许。它不用于自动发送。如果您在个人 WhatsApp 号码上运行,请使用相同的号码并启用 channels.whatsapp.selfChatMode

消息规范化(模型看到的内容)

  • Body 是带有信封的当前消息正文。
  • 引用回复上下文始终附加
    [回复给 +1555 id:ABC123]
    <引用的文本或 <媒体:...>>
    [/回复]
  • 同时设置回复元数据:
    • 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(默认):需要 @提及或正则表达式匹配。
    • always:始终触发。
  • /activation mention|always 仅限所有者使用,必须作为独立消息发送。
  • 所有者 = channels.whatsapp.allowFrom(如果未设置则为自身 E.164)。
  • 历史注入(仅待处理):
    • 最近的未处理消息(默认 50 条)插入到: [自您上次回复以来的聊天消息 - 用于上下文](已在会话中的消息不会被重新注入)
    • 当前消息在: [当前消息 - 回复此消息]
    • 发送者后缀附加:[来自: 姓名 (+E164)]
  • 群组元数据缓存 5 分钟(主题 + 参与者)。

回复投递(线程化)

  • WhatsApp Web 发送标准消息(当前网关中没有引用回复线程化)。
  • 回复标签在此通道上被忽略。

确认反应(接收时自动反应)

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

配置:

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

选项:

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

按账户覆盖:

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

行为说明:

  • 反应在消息接收后立即发送,在输入指示器或机器人回复之前。
  • requireMention: false(激活:always)的群组中,group: "mentions" 将对所有消息做出反应(不仅仅是 @提及)。
  • 发送即忘:反应失败会被记录但不阻止机器人回复。
  • 参与者 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 在限制内(调整大小 + 质量扫描)。
  • 超限媒体 => 错误;媒体回复回退到文本警告。

心跳

  • 网关心跳记录连接健康状态(web.heartbeatSeconds,默认 60 秒)。
  • 代理心跳可以按代理配置(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(DM 策略:pairing/allowlist/open/disabled)。
  • channels.whatsapp.selfChatMode(同手机设置;机器人使用您的个人 WhatsApp 号码)。
  • channels.whatsapp.allowFrom(DM 白名单)。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(DM 历史限制,以用户轮次计)。按用户覆盖: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.*

日志 + 故障排除

  • 子系统:whatsapp/inboundwhatsapp/outboundweb-heartbeatweb-reconnect
  • 日志文件:/tmp/openclaw/openclaw-YYYY-MM-DD.log(可配置)。
  • 故障排除指南:网关故障排除

快速故障排除

未链接 / 需要二维码登录

  • 症状: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 运行网关。(参见入门指南中的运行时说明。)