安装
openclaw onboard 和 openclaw channels add --channel whatsapp 会在你首次选择该插件时提示安装;如果插件缺失,openclaw channels login --channel whatsapp 也会提供相同的安装流程。开发检出使用本地插件路径;稳定版/测试版会先从 ClawHub 安装 @openclaw/whatsapp,失败后回退到 npm。WhatsApp 运行时在核心 OpenClaw npm 包之外发布,因此其运行时依赖会保留在外部插件中。手动安装:
@openclaw/whatsapp);只有在需要可复现安装时才固定精确版本。
配对
默认私信策略会要求未知发送者配对。
渠道故障排查
跨渠道诊断和修复手册。
Gateway 配置
完整的渠道配置模式和示例。
快速设置
链接 WhatsApp(二维码)
建议使用单独的 WhatsApp 号码(设置和元数据已为此优化),但也完全支持个人号码/自聊设置。
部署模式
专用号码(推荐)
专用号码(推荐)
- OpenClaw 使用单独的 WhatsApp 身份
- 私信允许列表和路由边界更清晰
- 降低自聊混淆的概率
个人号码回退
个人号码回退
新手引导支持个人号码模式,并会写入适合自聊的基线配置:
dmPolicy: "allowlist"、包含你自己号码的 allowFrom、selfChatMode: true。运行时自聊保护会基于已链接的自身号码和 allowFrom 生效。运行时模型
- Gateway 网关拥有 WhatsApp socket 和重连循环。
- watchdog 会独立跟踪两个信号:原始 WhatsApp Web 传输活动和应用消息活动。安静但仍连接的会话不会仅因为最近没有消息到达就重启;只有当传输帧在固定内部窗口内停止到达(不可由用户配置),或应用消息静默超过正常消息超时的 4 倍时,才会强制重连。对于最近活跃会话在重连后,首个窗口会使用较短的正常消息超时,而不是 4 倍窗口。OpenClaw 可以自动回复 Baileys 在该重连早期投递的离线消息,范围受入站消息 ID 去重生命周期限制;初始启动会保留较短的陈旧历史保护。
- Baileys socket 时间参数在
web.whatsapp.*下显式配置:keepAliveIntervalMs(应用 ping 间隔)、connectTimeoutMs(打开握手超时)、defaultQueryTimeoutMs(Baileys 查询等待,以及 OpenClaw 的出站发送/在线状态和入站已读回执超时)。 - 出站发送要求目标账号有活跃的 WhatsApp 监听器;否则会快速失败。
- 群组发送会在
@+<digits>和@<digits>令牌(文本和媒体标题中)匹配当前参与者元数据时附加原生提及元数据,包括基于 LID 的群组。 - 状态和广播聊天(
@status、@broadcast)会被忽略。 - 直接聊天使用私信会话规则(
session.dmScope;默认main会把私信合并到智能体主会话)。群组会话按 JID 隔离(agent:<agentId>:whatsapp:group:<jid>)。 - WhatsApp 频道/Newsletter 可通过其原生
@newsletterJID 作为显式出站目标,使用频道会话元数据(agent:<agentId>:whatsapp:channel:<jid>),而不是私信语义。 - WhatsApp Web 传输遵循 Gateway 网关主机上的标准代理环境变量(
HTTPS_PROXY、HTTP_PROXY、NO_PROXY及小写变体)。优先使用主机级代理配置,而不是按渠道设置。 - 启用
messages.removeAckAfterReply后,OpenClaw 会在可见回复送达后清除确认表情回应。
使用 MeowCaller 呼叫当前请求者(实验性)
该插件可以在来自 WhatsApp 的智能体轮次中暴露whatsapp_call。它使用 MeowCaller 向当前已授权请求者发起 WhatsApp 语音通话,并在对方接听后播放一条 OpenClaw TTS 消息。该工具没有目标号码参数,因此提示词无法重定向呼叫。默认禁用。
启用实验性呼叫
将 缺失或为
actions.calls: true 添加到 WhatsApp 渠道配置并重启 Gateway 网关:false 时,OpenClaw 不会暴露 whatsapp_call 工具。安装已审核的 MeowCaller CLI
适配器要求 Gateway 网关主机的 确保
PATH 中存在 meowcaller 可执行文件。在 MeowCaller PR #7 合并之前,请构建已审核分支:$HOME/.local/bin 位于 Gateway 网关服务的 PATH 中。此修订版包含显式的 pair 和仅发送的 notify 命令;notify 不会打开麦克风、扬声器、视频设备或诊断采集。不要替换为上游示例 CLI 的 play 命令。配对 MeowCaller 已链接设备
让 WhatsApp 智能体检查呼叫设置(以交互方式运行此命令,从 WhatsApp > Linked devices 扫描二维码,并等待
whatsapp_call 状态操作会报告账号特定的状态目录和配对命令)。对于默认账号:MeowCaller linked device ready。保持 wa-voip.db 私密,它是 MeowCaller 会话。非默认账号会从状态操作获得自己的存储路径;在 Windows 上,请运行其 PowerShell 命令。配置 TTS 并从 WhatsApp 发起呼叫
配置支持电话场景的 TTS 提供商,重启 Gateway 网关,然后发送类似
Call me and say the build finished. 的请求。该工具会从可信入站上下文解析发送者,合成一个临时私有 WAV 文件,在有界呼叫窗口内运行 MeowCaller,然后删除音频文件。OpenClaw 会显式传递账号的存储,等待接听/播放/挂断后返回零退出状态,并将超时或非零退出视为工具调用失败。审批提示
WhatsApp 可以将 Exec 和插件审批提示渲染为👍/👎 表情回应,由顶层审批转发配置控制:
approvals.exec 和 approvals.plugin 相互独立;将 WhatsApp 启用为渠道只会链接传输,除非对应审批类别已启用并路由到该处,否则不会发送任何内容。会话模式仅为源自 WhatsApp 的审批投递原生 emoji 审批。目标模式会对显式目标使用共享转发管线,不会创建单独的审批者私信扇出。
WhatsApp 审批表情回应要求 allowFrom(或 "*")中有显式审批者。defaultTo 设置普通默认消息目标,而不是审批者列表。手动 /approve 命令在审批解析前仍会经过正常的 WhatsApp 发送者授权路径。
插件钩子和隐私
入站 WhatsApp 消息可能携带个人内容、电话号码、群组标识符、发送者姓名和会话关联字段。除非你选择启用,否则 WhatsApp 不会向插件广播入站message_received 钩子载荷:
channels.whatsapp.accounts.<id>.pluginHooks.messageReceived 下的某个账号。仅对你信任其可访问入站 WhatsApp 内容和标识符的插件启用此项。
访问控制和激活
- 私信策略
- 群组策略和允许列表
- 提及和 /activation
channels.whatsapp.dmPolicy:| 值 | 行为 |
|---|---|
pairing(默认) | 未知发送者请求配对;所有者批准 |
allowlist | 仅允许 allowFrom 中的发送者进入 |
open | 要求 allowFrom 包含 "*" |
disabled | 阻止所有私信 |
allowFrom 接受 E.164 风格号码(内部规范化)。它只是私信发送者访问控制列表,不会限制向群组 JID 或 @newsletter 频道 JID 的显式出站发送。多账号覆盖:channels.whatsapp.accounts.<id>.dmPolicy(以及 .allowFrom)优先于该账号的渠道级默认值。运行时说明:- 配对会持久化到频道 allow-store,并与配置的
allowFrom合并 - 定时自动化和 Heartbeat 收件人回退使用显式递送目标或配置的
allowFrom;私信配对审批不会隐式成为 cron/Heartbeat 收件人 - 如果未配置允许列表,则默认允许已链接的本人号码
- OpenClaw 绝不会自动配对出站
fromMe私信(你从已链接设备发给自己的消息)
配置的 ACP 绑定
WhatsApp 通过顶层bindings[] 支持持久 ACP 绑定:
个人号码和自聊行为
当已链接的本人号码也存在于allowFrom 中时,自聊防护会激活:跳过自聊轮次的已读回执,忽略会 ping 你自己的提及 JID 自动触发行为,并在未设置 messages.responsePrefix 时默认将回复前缀设为 [{identity.name}](或 [openclaw])。
消息规范化和上下文
入站信封和回复上下文
入站信封和回复上下文
传入消息会包装在共享入站信封中。引用回复会按以下形式追加上下文:可用时会填充回复元数据(
ReplyToId、ReplyToBody、ReplyToSender、发送者 JID/E.164)。如果被引用的目标是可下载媒体,OpenClaw 会通过正常的入站媒体存储保存它,并暴露 MediaPath/MediaType,这样智能体可以直接检查它,而不是只能看到 <media:image>。媒体占位符和位置/联系人提取
媒体占位符和位置/联系人提取
仅媒体消息会规范化为占位符:
<media:image>、<media:video>、<media:audio>、<media:document>、<media:sticker>。授权群组语音备注会在正文仅为 <media:audio> 时,在提及门控之前转录,因此在语音备注中说出 Bot 提及也可以触发回复。如果转录仍未提及 Bot,它会保留在待处理群组历史中,而不是原始占位符。位置正文会呈现为简短坐标文本。位置标签/评论和联系人/vCard 详情会呈现为带围栏的不受信任元数据,而不是内联提示文本。待处理群组历史注入
待处理群组历史注入
未处理的群组消息会缓冲,并在 Bot 最终被触发时作为上下文注入。
- 默认限制:
50 - 配置:
channels.whatsapp.historyLimit,回退到messages.groupChat.historyLimit 0表示禁用
[Chat messages since your last reply - for context] 和 [Current message - respond to this]。已读回执
已读回执
对已接受的入站消息默认启用。全局禁用:单账号覆盖:
channels.whatsapp.accounts.<id>.sendReadReceipts。即使全局启用,自聊轮次也会跳过已读回执。递送、分块和媒体
文本分块
文本分块
- 默认分块限制:
channels.whatsapp.textChunkLimit = 4000 channels.whatsapp.chunkMode = "length" | "newline";newline优先使用段落边界(空行),然后回退到长度安全的分块
出站媒体行为
出站媒体行为
- 支持图片、视频、音频(PTT 语音备注)和文档载荷
- 音频会作为 Baileys
audio载荷发送,并带有ptt: true,呈现为一条按住说话语音备注;audioAsVoice会保留在回复载荷上,因此无论提供商的源格式如何,TTS 语音备注输出都会保持在这条路径上 - 原生 Ogg/Opus 音频会作为
audio/ogg; codecs=opus发送;其他任何格式(包括 Microsoft Edge TTS MP3/WebM 输出)都会在 PTT 递送前用ffmpeg转码为 48 kHz 单声道 Ogg/Opus /tts latest会将最新助手回复作为一条语音备注发送,并禁止对同一回复重复发送;/tts chat on|off|default控制当前聊天的自动 TTS- 视频发送时使用
gifPlayback: true可启用动画 GIF 播放 forceDocument/asDocument会将出站图片、GIF 和视频通过 Baileys 文档载荷路由,以避免 WhatsApp 的媒体压缩,同时保留解析出的文件名和 MIME 类型- 说明文字会应用到多媒体回复中的第一个媒体项,但 PTT 语音备注除外:音频会先发送且不带说明文字,然后说明文字会作为单独文本消息发送(WhatsApp 客户端不会一致地呈现语音备注说明文字)
- 媒体来源可以是 HTTP(S)、
file://或本地路径
媒体大小限制和回退行为
媒体大小限制和回退行为
- 入站保存上限和出站发送上限:
channels.whatsapp.mediaMaxMb(默认50) - 单账号覆盖:
channels.whatsapp.accounts.<id>.mediaMaxMb - 图片会自动优化(调整大小/质量扫描)以适配限制,除非
forceDocument/asDocument请求文档递送 - 媒体发送失败时,首项回退会发送一条文本警告,而不是静默丢弃响应
回复引用
channels.whatsapp.replyToMode 控制原生回复引用(出站回复会可见地引用入站消息):
| 值 | 行为 |
|---|---|
"off"(默认) | 从不引用;作为普通消息发送 |
"first" | 只引用第一个出站回复分块 |
"all" | 引用每个出站回复分块 |
"batched" | 引用排队的批量回复;立即回复不引用 |
channels.whatsapp.accounts.<id>.replyToMode。
表情回应级别
channels.whatsapp.reactionLevel 控制智能体使用 emoji 表情回应的范围:
| 级别 | 确认表情回应 | 智能体发起的表情回应 |
|---|---|---|
"off" | 否 | 否 |
"ack" | 是 | 否 |
"minimal"(默认) | 是 | 是,保守指导 |
"extensive" | 是 | 是,鼓励指导 |
channels.whatsapp.accounts.<id>.reactionLevel。
确认表情回应
channels.whatsapp.ackReaction 会在收到入站消息时立即发送表情回应,并受 reactionLevel 门控(为 "off" 时会被抑制):
ackReaction 但没有 emoji,WhatsApp 会使用路由智能体的身份 emoji,并回退到 ”👀“(省略 ackReaction 或设置 emoji: "" 表示不确认);失败会记录到日志,但不会阻止回复递送;群组模式 mentions 只会对由提及触发的轮次作出表情回应,而群组激活 always 会绕过该检查;WhatsApp 只使用 channels.whatsapp.ackReaction(旧版 messages.ackReaction 不适用于此处)。
生命周期状态表情回应
设置messages.statusReactions.enabled: true,让 WhatsApp 在轮次期间替换确认表情回应,而不是保留静态回执 emoji,并在排队、思考、工具活动、压缩、完成和错误等状态之间循环:
channels.whatsapp.ackReaction 仍控制直接消息和群组的资格;排队状态使用与普通确认表情回应相同的有效 emoji;WhatsApp 每条消息只有一个 Bot 表情回应槽位,因此生命周期更新会就地替换当前表情回应;messages.removeAckAfterReply: true 会在配置的完成/错误保留时间后清除最终状态表情回应;工具 emoji 类别包括 tool、coding、web、deploy、build 和 concierge。
多账号和凭证
账号选择和默认值
账号选择和默认值
账号 ID 来自
channels.whatsapp.accounts。默认账号选择规则是:如果存在 default 则使用它,否则使用第一个已配置账号 ID(按字母顺序排序)。账号 ID 会在内部规范化以用于查找。凭证路径和旧版兼容性
凭证路径和旧版兼容性
- 当前凭证路径:
~/.openclaw/credentials/whatsapp/<accountId>/creds.json(备份:creds.json.bak) ~/.openclaw/credentials/中的旧版默认凭证仍会在默认账号流程中被识别/迁移
退出登录行为
退出登录行为
openclaw channels logout --channel whatsapp [--account <id>] 会清除该账号的 WhatsApp 凭证状态。当 Gateway 网关可达时,退出登录会先停止该账号的实时监听器,因此关联会话会在下次重启前停止接收消息。openclaw channels remove --channel whatsapp 也会在禁用或删除账号配置前停止实时监听器。在旧版凭证目录中,oauth.json 会保留,而 Baileys 凭证文件会被移除。工具、操作和配置写入
- 智能体工具支持包括 WhatsApp 表情回应操作(
react)。 - 操作门控:
channels.whatsapp.actions.reactions、channels.whatsapp.actions.polls(现有操作默认值为true)、channels.whatsapp.actions.calls(默认值为false,请参见上面的 MeowCaller)。 - 渠道发起的配置写入默认启用;可通过
channels.whatsapp.configWrites: false禁用。
故障排查
未关联(需要 QR)
未关联(需要 QR)
症状:渠道状态报告未关联。
已关联但已断开 / 重新连接循环
已关联但已断开 / 重新连接循环
症状:已关联账号反复断开连接或尝试重新连接。安静账号可以在正常消息超时后仍保持连接;只有在 WhatsApp Web 传输活动停止、socket 关闭,或应用层活动在更长的安全窗口后仍保持静默时,watchdog 才会重启(请参见上面的运行时模型)。如果日志显示重复的 修复:如果在主机连接和计时修复后循环仍然存在,请备份账号凭证目录并重新关联:如果
status=408 Request Time-out Connection was lost,请调整 web.whatsapp 下的 Baileys socket 计时。先将 keepAliveIntervalMs 缩短到低于你的网络空闲超时,并在较慢或丢包链路上增加 connectTimeoutMs:~/.openclaw/logs/whatsapp-health.log 显示 Gateway inactive,但 openclaw gateway status 和 openclaw channels status --probe 都显示健康,请运行 openclaw doctor。在 Linux 上,Doctor 会警告调用已退役 ~/.openclaw/bin/ensure-whatsapp.sh 脚本的旧版 crontab 条目;请用 crontab -e 删除这些条目 — cron 可能缺少 systemd 用户总线环境,导致旧脚本错误报告 Gateway 网关健康状态。代理后面的 QR 登录超时
代理后面的 QR 登录超时
症状:
openclaw channels login --channel whatsapp 在显示可用 QR 前失败,并显示 status=408 Request Time-out 或 TLS socket 断开连接。WhatsApp Web 登录使用 Gateway 网关主机的标准代理环境(HTTPS_PROXY、HTTP_PROXY、小写变体、NO_PROXY)。确认 Gateway 网关进程继承了代理环境变量,并且 NO_PROXY 不匹配 mmg.whatsapp.net。发送时没有活动监听器
发送时没有活动监听器
当目标账号不存在活动 Gateway 网关监听器时,出站发送会快速失败。确认 Gateway 网关正在运行且账号已关联。
回复出现在转录中但未出现在 WhatsApp 中
回复出现在转录中但未出现在 WhatsApp 中
转录行记录智能体生成的内容;WhatsApp 投递会单独检查。只有在 Baileys 为至少一次可见文本或媒体发送返回出站消息 ID 后,OpenClaw 才会将自动回复视为已发送。Ack 表情回应是独立的回复前回执 — 成功的表情回应不能证明后续文本/媒体回复已被接受。请检查 Gateway 网关日志中是否有
auto-reply delivery failed 或 auto-reply was not accepted by WhatsApp provider。群组消息被意外忽略
群组消息被意外忽略
按此顺序检查:
groupPolicy、groupAllowFrom/allowFrom、groups 允许列表条目、提及门控(requireMention + 提及模式),以及 openclaw.json 中的重复键(JSON5 的后续条目会覆盖前面的条目 — 每个作用域只保留一个 groupPolicy)。如果存在 channels.whatsapp.groups,WhatsApp 仍可观察来自其他群组的消息,但 OpenClaw 会在会话路由前丢弃它们。将群组 JID 添加到 channels.whatsapp.groups,或添加 groups["*"] 以允许所有群组,同时通过 groupPolicy/groupAllowFrom 保持发送者授权。Bun 运行时警告
Bun 运行时警告
WhatsApp Gateway 网关运行时应使用 Node。Bun 被标记为不兼容稳定的 WhatsApp/Telegram Gateway 网关操作。
系统提示
WhatsApp 支持通过groups 和 direct 映射为群组和直接聊天配置 Telegram 风格的系统提示。
群组消息的解析方式:首先确定有效的 groups 映射 — 如果账号定义了自己的 groups 键,无论如何都会完全替换根 groups 映射(不进行深度合并)。然后在这个单一结果映射上执行提示查找:
- 群组专属提示(
groups["<groupId>"].systemPrompt):当群组条目存在且其systemPrompt键已定义时使用。空字符串("")会抑制通配符,并且不应用任何提示。 - 群组通配符提示(
groups["*"].systemPrompt):当特定群组条目不存在,或存在但没有systemPrompt键时使用。
direct 映射和 direct["*"]。
dms 仍是轻量级的每个私信历史记录覆盖桶(dms.<id>.historyLimit)。提示覆盖位于 direct 下。这种用于提示解析的账号替换根行为是普通的浅层覆盖:任何账号
groups/direct 键,包括显式空对象,都会替换根映射。它不同于上面描述的群组成员允许列表检查,后者针对意外为空的 groups: {} 提供单账号安全网。groups(即使账号没有自己的 groups),以避免机器人接收它不属于的群组消息。WhatsApp 不应用该保护 — 对于没有自身覆盖的任何账号,无论账号数量多少,都会继承根 groups/direct。在多账号 WhatsApp 设置中,如果你想使用每账号提示,请在每个账号下显式定义完整映射。
重要行为:
channels.whatsapp.groups既是每群组配置映射,也是聊天级群组允许列表。在根作用域或账号作用域中,groups["*"]表示该作用域“允许所有群组”。- 只有当你已经希望该作用域允许所有群组时,才添加通配符
systemPrompt。如果只想让固定的一组群组 ID 符合条件,请在每个显式允许列表条目上重复提示,而不要使用groups["*"]。 - 群组准入和发送者授权是独立检查。
groups["*"]会扩大哪些群组进入群组处理;它不会授权这些群组中的每个发送者 — 这仍由groupPolicy/groupAllowFrom控制。 channels.whatsapp.direct对私信没有等效副作用:direct["*"]仅在私信已通过dmPolicy加allowFrom或配对存储规则准入后提供默认配置。
配置参考指针
主要参考:配置参考 - WhatsApp| 区域 | 字段 |
|---|---|
| 访问 | dmPolicy, allowFrom, groupPolicy, groupAllowFrom, groups |
| 投递 | textChunkLimit, chunkMode, mediaMaxMb, sendReadReceipts, ackReaction, reactionLevel |
| 多账号 | accounts.<id>.enabled、accounts.<id>.authDir 和其他每账号覆盖 |
| 运维 | configWrites, debounceMs, web.enabled, web.heartbeatSeconds, web.reconnect.*, web.whatsapp.* |
| 会话行为 | session.dmScope, historyLimit, dmHistoryLimit, dms.<id>.historyLimit |
| 提示 | groups.<id>.systemPrompt, groups["*"].systemPrompt, direct.<id>.systemPrompt, direct["*"].systemPrompt |