chore(i18n): refresh zh-CN translations
This commit is contained in:
openclaw-docs-i18n[bot]
parent
593698238d
commit
733566bc2b
@ -1,29 +1,28 @@
|
||||
---
|
||||
read_when:
|
||||
- 正在处理 WhatsApp / 网页渠道行为或收件箱路由
|
||||
- 处理 WhatsApp/web 渠道行为或收件箱路由
|
||||
summary: WhatsApp 渠道支持、访问控制、投递行为和运维
|
||||
title: WhatsApp
|
||||
x-i18n:
|
||||
generated_at: "2026-04-26T04:50:08Z"
|
||||
generated_at: "2026-04-26T16:54:53Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: fd4217adb673bc4c071fc1bff6994fb214966c2b28fe59253a1a6f4b4b7fcdba
|
||||
source_hash: 120a41eabfd7eb2a68555609f8f8282025ecedf54fae9846e85f78f5de2825a1
|
||||
source_path: channels/whatsapp.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
Status：通过 WhatsApp Web（Baileys）已可用于生产环境。Gateway 网关拥有已关联的会话。
|
||||
Status：通过 WhatsApp Web（Baileys）已达到生产就绪状态。Gateway 网关拥有已关联的会话。
|
||||
|
||||
## 安装（按需）
|
||||
|
||||
- 新手引导（`openclaw onboard`）和 `openclaw channels add --channel whatsapp`
|
||||
会在你第一次选择 WhatsApp 插件时提示安装它。
|
||||
- `openclaw channels login --channel whatsapp` 也会在
|
||||
插件尚未安装时提供安装流程。
|
||||
会在你第一次选择 WhatsApp 插件时提示安装。
|
||||
- 当插件尚未安装时，`openclaw channels login --channel whatsapp` 也会提供安装流程。
|
||||
- 开发渠道 + git 检出：默认使用本地插件路径。
|
||||
- Stable/Beta：默认使用 npm 包 `@openclaw/whatsapp`。
|
||||
|
||||
仍然可以手动安装：
|
||||
也仍然支持手动安装：
|
||||
|
||||
```bash
|
||||
openclaw plugins install @openclaw/whatsapp
|
||||
@ -31,13 +30,13 @@ openclaw plugins install @openclaw/whatsapp
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card title="配对" icon="link" href="/zh-CN/channels/pairing">
|
||||
未知发送者的默认私信策略是配对。
|
||||
对于未知发送者，默认的私信策略是配对。
|
||||
</Card>
|
||||
<Card title="渠道故障排除" icon="wrench" href="/zh-CN/channels/troubleshooting">
|
||||
跨渠道诊断与修复操作手册。
|
||||
</Card>
|
||||
<Card title="Gateway 网关配置" icon="settings" href="/zh-CN/gateway/configuration">
|
||||
完整的渠道配置模式和示例。
|
||||
完整的渠道配置模式与示例。
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
@ -67,13 +66,13 @@ openclaw plugins install @openclaw/whatsapp
|
||||
openclaw channels login --channel whatsapp
|
||||
```
|
||||
|
||||
对于特定账号：
|
||||
对于特定账户：
|
||||
|
||||
```bash
|
||||
openclaw channels login --channel whatsapp --account work
|
||||
```
|
||||
|
||||
若要在登录前附加现有/自定义的 WhatsApp Web 认证目录：
|
||||
如需在登录前附加现有/自定义的 WhatsApp Web 凭证目录：
|
||||
|
||||
```bash
|
||||
openclaw channels add --channel whatsapp --account work --auth-dir /path/to/wa-auth
|
||||
@ -103,17 +102,17 @@ openclaw pairing approve whatsapp <CODE>
|
||||
</Steps>
|
||||
|
||||
<Note>
|
||||
OpenClaw 建议尽可能为 WhatsApp 使用单独的号码。（渠道元数据和设置流程已针对这种设置进行优化，但也支持个人号码设置。）
|
||||
OpenClaw 建议尽可能为 WhatsApp 使用单独的号码。（渠道元数据和设置流程已针对该设置进行优化，但也支持个人号码设置。）
|
||||
</Note>
|
||||
|
||||
## 部署模式
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="专用号码（推荐）">
|
||||
这是最清晰的运维模式：
|
||||
这是最简洁的运维模式：
|
||||
|
||||
- OpenClaw 使用独立的 WhatsApp 身份
|
||||
- 更清晰的私信允许列表和路由边界
|
||||
- 为 OpenClaw 使用单独的 WhatsApp 身份
|
||||
- 更清晰的私信 allowlist 和路由边界
|
||||
- 更低的自聊混淆概率
|
||||
|
||||
最小策略模式：
|
||||
@ -138,12 +137,12 @@ OpenClaw 建议尽可能为 WhatsApp 使用单独的号码。（渠道元数据
|
||||
- `allowFrom` 包含你的个人号码
|
||||
- `selfChatMode: true`
|
||||
|
||||
在运行时，自聊保护依赖已关联的自身号码和 `allowFrom`。
|
||||
在运行时，自聊保护会依据已关联的自身号码和 `allowFrom` 生效。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="仅限 WhatsApp Web 的渠道范围">
|
||||
当前 OpenClaw 渠道架构中的消息平台渠道基于 WhatsApp Web（`Baileys`）。
|
||||
在当前 OpenClaw 渠道架构中，消息平台渠道基于 WhatsApp Web（`Baileys`）。
|
||||
|
||||
内置聊天渠道注册表中没有单独的 Twilio WhatsApp 消息渠道。
|
||||
|
||||
@ -153,19 +152,20 @@ OpenClaw 建议尽可能为 WhatsApp 使用单独的号码。（渠道元数据
|
||||
## 运行时模型
|
||||
|
||||
- Gateway 网关拥有 WhatsApp socket 和重连循环。
|
||||
- 向外发送消息要求目标账号存在活跃的 WhatsApp 监听器。
|
||||
- 会忽略状态和广播聊天（`@status`、`@broadcast`）。
|
||||
- 重连看门狗依据 WhatsApp Web 传输活动，而不只是入站应用消息量，因此一个安静的已关联设备会话不会仅仅因为最近没人发消息而被重启。如果传输帧持续到达，但在看门狗窗口期间没有处理任何应用消息，更长的应用静默上限仍会强制重连。
|
||||
- 出站发送要求目标账户存在活动中的 WhatsApp 监听器。
|
||||
- Status 和广播聊天会被忽略（`@status`、`@broadcast`）。
|
||||
- 直接聊天使用私信会话规则（`session.dmScope`；默认 `main` 会将私信折叠到智能体主会话）。
|
||||
- 群组会话彼此隔离（`agent:<agentId>:whatsapp:group:<jid>`）。
|
||||
- WhatsApp Web 传输遵循 Gateway 网关主机上的标准代理环境变量（`HTTPS_PROXY`、`HTTP_PROXY`、`NO_PROXY` / 小写变体）。优先使用主机级代理配置，而不是渠道专用的 WhatsApp 代理设置。
|
||||
- 启用 `messages.removeAckAfterReply` 时，OpenClaw 会在可见回复送达后清除 WhatsApp 的确认反应。
|
||||
- WhatsApp Web 传输遵循 Gateway 网关主机上的标准代理环境变量（`HTTPS_PROXY`、`HTTP_PROXY`、`NO_PROXY` 及其小写变体）。优先使用主机级代理配置，而不是渠道专用的 WhatsApp 代理设置。
|
||||
- 当启用 `messages.removeAckAfterReply` 时，OpenClaw 会在可见回复送达后清除 WhatsApp 的确认反应。
|
||||
|
||||
## 插件钩子和隐私
|
||||
## 插件钩子与隐私
|
||||
|
||||
WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
群组标识符、发送者姓名以及会话关联字段。因此，
|
||||
除非你显式选择启用，否则 WhatsApp 不会将入站 `message_received`
|
||||
钩子负载广播给插件：
|
||||
除非你明确选择启用，否则 WhatsApp 不会向插件广播入站
|
||||
`message_received` 钩子负载：
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -179,7 +179,7 @@ WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
}
|
||||
```
|
||||
|
||||
你也可以将此启用范围限定到某一个账号：
|
||||
你也可以将启用范围限定到某个账户：
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -197,8 +197,8 @@ WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
}
|
||||
```
|
||||
|
||||
仅当你信任这些插件可以接收入站 WhatsApp 消息内容和标识符时，
|
||||
才启用此选项。
|
||||
只有当你信任相关插件可以接收 WhatsApp 入站消息内容
|
||||
和标识符时，才启用此选项。
|
||||
|
||||
## 访问控制与激活
|
||||
|
||||
@ -211,79 +211,79 @@ WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
- `open`（要求 `allowFrom` 包含 `"*"`）
|
||||
- `disabled`
|
||||
|
||||
`allowFrom` 接受 E.164 风格号码（内部会进行标准化）。
|
||||
`allowFrom` 接受 E.164 风格的号码（内部会进行标准化）。
|
||||
|
||||
多账号覆盖：该账号的 `channels.whatsapp.accounts.<id>.dmPolicy`（以及 `allowFrom`）会优先于渠道级默认值。
|
||||
多账户覆盖：对于该账户，`channels.whatsapp.accounts.<id>.dmPolicy`（以及 `allowFrom`）优先于渠道级默认值。
|
||||
|
||||
运行时行为细节：
|
||||
|
||||
- 配对会持久化到渠道允许存储中，并与已配置的 `allowFrom` 合并
|
||||
- 如果没有配置允许列表，则默认允许已关联的自身号码
|
||||
- 如果未配置 allowlist，则默认允许已关联的自身号码
|
||||
- OpenClaw 绝不会自动配对出站的 `fromMe` 私信（即你从已关联设备发给自己的消息）
|
||||
|
||||
</Tab>
|
||||
|
||||
<Tab title="群组策略 + 允许列表">
|
||||
<Tab title="群组策略 + allowlist">
|
||||
群组访问有两层：
|
||||
|
||||
1. **群组成员允许列表**（`channels.whatsapp.groups`）
|
||||
- 如果省略 `groups`，则所有群组都有资格接入
|
||||
- 如果存在 `groups`，它将作为群组允许列表（允许使用 `"*"`）
|
||||
1. **群组成员资格 allowlist**（`channels.whatsapp.groups`）
|
||||
- 如果省略 `groups`，则所有群组都有资格
|
||||
- 如果存在 `groups`，它将作为群组 allowlist（允许 `"*"`）
|
||||
|
||||
2. **群组发送者策略**（`channels.whatsapp.groupPolicy` + `groupAllowFrom`）
|
||||
- `open`：绕过发送者允许列表
|
||||
- `open`：绕过发送者 allowlist
|
||||
- `allowlist`：发送者必须匹配 `groupAllowFrom`（或 `*`）
|
||||
- `disabled`：阻止所有群组入站消息
|
||||
|
||||
发送者允许列表回退规则：
|
||||
发送者 allowlist 回退规则：
|
||||
|
||||
- 如果未设置 `groupAllowFrom`，运行时会在可用时回退到 `allowFrom`
|
||||
- 发送者允许列表会在提及/回复激活之前进行评估
|
||||
- 在 mention/reply 激活之前，会先评估发送者 allowlist
|
||||
|
||||
注意：如果完全不存在 `channels.whatsapp` 配置块，运行时的群组策略回退值为 `allowlist`（并记录警告日志），即使设置了 `channels.defaults.groupPolicy` 也是如此。
|
||||
注意：如果完全不存在 `channels.whatsapp` 配置块，则运行时群组策略回退为 `allowlist`（并记录一条警告日志），即使设置了 `channels.defaults.groupPolicy` 也是如此。
|
||||
|
||||
</Tab>
|
||||
|
||||
<Tab title="提及 + /activation">
|
||||
群组回复默认需要提及。
|
||||
默认情况下，群组回复需要被提及。
|
||||
|
||||
提及检测包括：
|
||||
|
||||
- 对机器人身份的显式 WhatsApp 提及
|
||||
- 已配置的提及正则模式（`agents.list[].groupChat.mentionPatterns`，回退到 `messages.groupChat.mentionPatterns`）
|
||||
- 已授权群组消息的入站语音笔记转录
|
||||
- 隐式回复机器人检测（回复发送者与机器人身份匹配）
|
||||
- 已配置的提及正则模式（`agents.list[].groupChat.mentionPatterns`，回退为 `messages.groupChat.mentionPatterns`）
|
||||
- 对已授权群组消息的入站语音笔记转写
|
||||
- 隐式回复机器人的检测（回复发送者与机器人身份匹配）
|
||||
|
||||
安全说明：
|
||||
|
||||
- 引用/回复仅满足提及门控；它**不会**授予发送者授权
|
||||
- 当 `groupPolicy: "allowlist"` 时，未在允许列表中的发送者即使回复了允许列表用户的消息，仍会被阻止
|
||||
- 引用/回复只能满足提及门控；它**不会**授予发送者授权
|
||||
- 使用 `groupPolicy: "allowlist"` 时，即使非 allowlist 发送者回复了 allowlist 用户的消息，也仍会被阻止
|
||||
|
||||
会话级激活命令：
|
||||
|
||||
- `/activation mention`
|
||||
- `/activation always`
|
||||
|
||||
`activation` 会更新会话状态（而不是全局配置）。它受 owner 权限控制。
|
||||
`activation` 会更新会话状态（而不是全局配置）。它受所有者权限控制。
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## 个人号码和自聊行为
|
||||
## 个人号码与自聊行为
|
||||
|
||||
当已关联的自身号码也存在于 `allowFrom` 中时，WhatsApp 自聊保护会生效：
|
||||
当已关联的自身号码也存在于 `allowFrom` 中时，WhatsApp 自聊保护会启用：
|
||||
|
||||
- 跳过自聊轮次的已读回执
|
||||
- 忽略原本会提醒你自己的 mention-JID 自动触发行为
|
||||
- 忽略 mention-JID 自动触发行为，以避免给你自己发送提醒
|
||||
- 如果未设置 `messages.responsePrefix`，自聊回复默认使用 `[{identity.name}]` 或 `[openclaw]`
|
||||
|
||||
## 消息标准化和上下文
|
||||
## 消息标准化与上下文
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="入站封装 + 回复上下文">
|
||||
入站 WhatsApp 消息会被封装进共享的入站信封结构中。
|
||||
<Accordion title="入站信封 + 回复上下文">
|
||||
传入的 WhatsApp 消息会被包装进共享的入站信封中。
|
||||
|
||||
如果存在引用回复，上下文会以下列形式追加：
|
||||
如果存在引用回复，上下文会以以下形式追加：
|
||||
|
||||
```text
|
||||
[Replying to <sender> id:<stanzaId>]
|
||||
@ -291,7 +291,7 @@ WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
[/Replying]
|
||||
```
|
||||
|
||||
若可用，也会填充回复元数据字段（`ReplyToId`、`ReplyToBody`、`ReplyToSender`、发送者 JID/E.164）。
|
||||
在可用时，也会填充回复元数据字段（`ReplyToId`、`ReplyToBody`、`ReplyToSender`、发送者 JID/E.164）。
|
||||
|
||||
</Accordion>
|
||||
|
||||
@ -304,16 +304,16 @@ WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
- `<media:document>`
|
||||
- `<media:sticker>`
|
||||
|
||||
对于已授权群组中的语音笔记，如果消息正文仅为 `<media:audio>`，会在提及门控之前先进行转录，因此在语音笔记中说出机器人的提及内容也可以触发回复。如果转录内容仍然没有提及机器人，转录文本会保留在待处理群组历史中，而不是保留原始占位符。
|
||||
对于已授权群组消息，当消息体仅为 `<media:audio>` 时，会在提及门控之前先转写语音笔记，因此在语音中说出对机器人的提及也可以触发回复。如果转写结果仍未提及机器人，则会把转写文本保留在待处理群组历史中，而不是原始占位符。
|
||||
|
||||
位置正文使用简洁的坐标文本。位置标签/备注以及联系人/vCard 详细信息会渲染为带围栏的不受信任元数据，而不是内联提示文本。
|
||||
位置消息体使用简洁的坐标文本。位置标签/备注以及联系人/vCard 详情会渲染为带围栏的不受信任元数据，而不是内联提示文本。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="待处理群组历史注入">
|
||||
对于群组，未处理的消息可以被缓冲，并在机器人最终被触发时作为上下文注入。
|
||||
|
||||
- 默认上限：`50`
|
||||
- 默认限制：`50`
|
||||
- 配置：`channels.whatsapp.historyLimit`
|
||||
- 回退：`messages.groupChat.historyLimit`
|
||||
- `0` 表示禁用
|
||||
@ -340,7 +340,7 @@ WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
}
|
||||
```
|
||||
|
||||
按账号覆盖：
|
||||
按账户覆盖：
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -361,48 +361,48 @@ WhatsApp 入站消息可能包含个人消息内容、电话号码、
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## 投递、分块和媒体
|
||||
## 投递、分块与媒体
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="文本分块">
|
||||
- 默认分块上限：`channels.whatsapp.textChunkLimit = 4000`
|
||||
- 默认分块限制：`channels.whatsapp.textChunkLimit = 4000`
|
||||
- `channels.whatsapp.chunkMode = "length" | "newline"`
|
||||
- `newline` 模式优先按段落边界（空行）分块，然后再回退到按长度安全分块
|
||||
- `newline` 模式优先按段落边界（空行）分块，然后回退到按长度安全分块
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="出站媒体行为">
|
||||
- 支持图片、视频、音频（PTT 语音笔记）和文档负载
|
||||
- 音频媒体通过 Baileys 的 `audio` 负载发送，并带有 `ptt: true`，因此 WhatsApp 客户端会将其渲染为按住说话语音笔记
|
||||
- 回复负载会保留 `audioAsVoice`；WhatsApp 的 TTS 语音笔记输出即使提供商返回的是 MP3 或 WebM，也仍然走这条 PTT 路径
|
||||
- 原生 Ogg/Opus 音频会以 `audio/ogg; codecs=opus` 发送，以兼容语音笔记
|
||||
- 非 Ogg 音频（包括 Microsoft Edge TTS 的 MP3/WebM 输出）会在 PTT 投递前使用 `ffmpeg` 转码为 48 kHz 单声道 Ogg/Opus
|
||||
- `/tts latest` 会将最新的助手回复作为一条语音笔记发送，并抑制同一回复的重复发送；`/tts chat on|off|default` 控制当前 WhatsApp 聊天的自动 TTS
|
||||
- 动态 GIF 播放通过视频发送上的 `gifPlayback: true` 支持
|
||||
- 发送多媒体回复负载时，说明文字会应用到第一项媒体；但 PTT 语音笔记会先发送音频，再单独发送可见文本，因为 WhatsApp 客户端对语音笔记说明文字的渲染并不一致
|
||||
- 支持图像、视频、音频（PTT 语音便笺）和文档负载
|
||||
- 音频媒体通过 Baileys 的 `audio` 负载发送，并带有 `ptt: true`，因此 WhatsApp 客户端会将其渲染为按住说话语音便笺
|
||||
- 回复负载会保留 `audioAsVoice`；即使提供商返回的是 MP3 或 WebM，WhatsApp 的 TTS 语音便笺输出仍会走这条 PTT 路径
|
||||
- 原生 Ogg/Opus 音频会以 `audio/ogg; codecs=opus` 发送，以确保语音便笺兼容性
|
||||
- 非 Ogg 音频（包括 Microsoft Edge TTS 的 MP3/WebM 输出）会先通过 `ffmpeg` 转码为 48 kHz 单声道 Ogg/Opus，然后再以 PTT 方式投递
|
||||
- `/tts latest` 会将最新的助手回复作为一条语音便笺发送，并抑制同一回复的重复发送；`/tts chat on|off|default` 用于控制当前 WhatsApp 聊天的自动 TTS
|
||||
- 通过在视频发送中设置 `gifPlayback: true`，支持动画 GIF 播放
|
||||
- 发送多媒体回复负载时，说明文字会应用到第一个媒体项；但 PTT 语音便笺会先发送音频，并将可见文本单独发送，因为 WhatsApp 客户端对语音便笺说明文字的渲染并不稳定
|
||||
- 媒体来源可以是 HTTP(S)、`file://` 或本地路径
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="媒体大小限制和回退行为">
|
||||
<Accordion title="媒体大小限制与回退行为">
|
||||
- 入站媒体保存上限：`channels.whatsapp.mediaMaxMb`（默认 `50`）
|
||||
- 出站媒体发送上限：`channels.whatsapp.mediaMaxMb`（默认 `50`）
|
||||
- 按账号覆盖使用 `channels.whatsapp.accounts.<accountId>.mediaMaxMb`
|
||||
- 图片会自动优化（调整尺寸/质量扫描）以满足限制
|
||||
- 按账户覆盖使用 `channels.whatsapp.accounts.<accountId>.mediaMaxMb`
|
||||
- 图像会自动优化（尺寸调整/质量扫描）以满足限制
|
||||
- 媒体发送失败时，首项回退会发送文本警告，而不是静默丢弃响应
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## 回复引用
|
||||
|
||||
WhatsApp 支持原生回复引用，即出站回复会以可见方式引用入站消息。可通过 `channels.whatsapp.replyToMode` 控制。
|
||||
WhatsApp 支持原生回复引用，出站回复会可见地引用入站消息。使用 `channels.whatsapp.replyToMode` 进行控制。
|
||||
|
||||
| 值 | 行为 |
|
||||
| ----------- | --------------------------------------------------------------------- |
|
||||
| `"off"` | 从不引用；作为普通消息发送 |
|
||||
| `"first"` | 仅引用第一段出站回复分块 |
|
||||
| `"all"` | 引用每一段出站回复分块 |
|
||||
| `"batched"` | 引用排队的批量回复，同时让即时回复不带引用 |
|
||||
| 值 | 行为 |
|
||||
| ----------- | ----------------------------------------- |
|
||||
| `"off"` | 从不引用；作为普通消息发送 |
|
||||
| `"first"` | 只引用第一段出站回复分块 |
|
||||
| `"all"` | 引用每一段出站回复分块 |
|
||||
| `"batched"` | 引用排队的批量回复，同时让即时回复不带引用 |
|
||||
|
||||
默认值为 `"off"`。按账号覆盖使用 `channels.whatsapp.accounts.<id>.replyToMode`。
|
||||
默认值为 `"off"`。按账户覆盖使用 `channels.whatsapp.accounts.<id>.replyToMode`。
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -416,18 +416,18 @@ WhatsApp 支持原生回复引用，即出站回复会以可见方式引用入
|
||||
|
||||
## 反应级别
|
||||
|
||||
`channels.whatsapp.reactionLevel` 控制智能体在 WhatsApp 上使用 emoji 反应的范围：
|
||||
`channels.whatsapp.reactionLevel` 控制智能体在 WhatsApp 上使用 emoji 反应的广泛程度：
|
||||
|
||||
| 级别 | Ack 反应 | 智能体主动发起的反应 | 说明 |
|
||||
| ------------ | -------- | -------------------- | ------------------------------------ |
|
||||
| `"off"` | 否 | 否 | 完全不使用反应 |
|
||||
| `"ack"` | 是 | 否 | 仅使用 Ack 反应（回复前确认） |
|
||||
| `"minimal"` | 是 | 是（保守） | Ack + 智能体反应，采用保守指导 |
|
||||
| `"extensive"`| 是 | 是（鼓励） | Ack + 智能体反应，采用鼓励式指导 |
|
||||
| 级别 | 确认反应 | 智能体主动反应 | 说明 |
|
||||
| ------------- | -------- | --------------------- | ------------------------------------ |
|
||||
| `"off"` | 否 | 否 | 完全不使用反应 |
|
||||
| `"ack"` | 是 | 否 | 仅确认反应（回复前回执） |
|
||||
| `"minimal"` | 是 | 是（保守） | 确认 + 带保守指导的智能体反应 |
|
||||
| `"extensive"` | 是 | 是（鼓励使用） | 确认 + 带鼓励性指导的智能体反应 |
|
||||
|
||||
默认值：`"minimal"`。
|
||||
|
||||
按账号覆盖使用 `channels.whatsapp.accounts.<id>.reactionLevel`。
|
||||
按账户覆盖使用 `channels.whatsapp.accounts.<id>.reactionLevel`。
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -441,8 +441,8 @@ WhatsApp 支持原生回复引用，即出站回复会以可见方式引用入
|
||||
|
||||
## 确认反应
|
||||
|
||||
WhatsApp 支持通过 `channels.whatsapp.ackReaction` 在收到入站消息时立即发送 Ack 反应。
|
||||
Ack 反应受 `reactionLevel` 控制——当 `reactionLevel` 为 `"off"` 时会被抑制。
|
||||
WhatsApp 支持通过 `channels.whatsapp.ackReaction` 在接收入站消息时立即发送确认反应。
|
||||
确认反应受 `reactionLevel` 控制——当 `reactionLevel` 为 `"off"` 时会被抑制。
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -460,47 +460,47 @@ Ack 反应受 `reactionLevel` 控制——当 `reactionLevel` 为 `"off"` 时会
|
||||
|
||||
行为说明：
|
||||
|
||||
- 在入站消息被接受后立即发送（回复前）
|
||||
- 失败会记录日志，但不会阻止正常回复投递
|
||||
- 群组模式 `mentions` 会在由提及触发的轮次中发送反应；群组激活 `always` 会绕过此检查
|
||||
- WhatsApp 使用 `channels.whatsapp.ackReaction`（此处不使用旧版 `messages.ackReaction`）
|
||||
- 在入站消息被接受后立即发送（回复之前）
|
||||
- 失败会被记录日志，但不会阻塞正常回复投递
|
||||
- 群组模式 `mentions` 会在由提及触发的轮次中发送反应；群组激活模式 `always` 可绕过此检查
|
||||
- WhatsApp 使用 `channels.whatsapp.ackReaction`（这里不使用旧版 `messages.ackReaction`）
|
||||
|
||||
## 多账号和凭证
|
||||
## 多账户与凭证
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="账号选择和默认值">
|
||||
- 账号 id 来自 `channels.whatsapp.accounts`
|
||||
- 默认账号选择：如果存在则为 `default`，否则为首个已配置的账号 id（排序后）
|
||||
- 账号 id 会在内部标准化后用于查找
|
||||
<Accordion title="账户选择与默认值">
|
||||
- 账户 id 来自 `channels.whatsapp.accounts`
|
||||
- 默认账户选择：如果存在则为 `default`，否则为第一个已配置的账户 id（已排序）
|
||||
- 账户 id 会在内部标准化后用于查找
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="凭证路径和旧版兼容性">
|
||||
<Accordion title="凭证路径与旧版兼容性">
|
||||
- 当前认证路径：`~/.openclaw/credentials/whatsapp/<accountId>/creds.json`
|
||||
- 备份文件：`creds.json.bak`
|
||||
- `~/.openclaw/credentials/` 中的旧版默认认证仍会被识别/迁移，用于默认账号流程
|
||||
- `~/.openclaw/credentials/` 中的旧版默认认证仍可识别/迁移，用于默认账户流程
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="登出行为">
|
||||
`openclaw channels logout --channel whatsapp [--account <id>]` 会清除该账号的 WhatsApp 认证状态。
|
||||
`openclaw channels logout --channel whatsapp [--account <id>]` 会清除该账户的 WhatsApp 认证状态。
|
||||
|
||||
在旧版认证目录中，会保留 `oauth.json`，同时移除 Baileys 认证文件。
|
||||
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## 工具、操作和配置写入
|
||||
## 工具、动作与配置写入
|
||||
|
||||
- 智能体工具支持包括 WhatsApp 反应操作（`react`）。
|
||||
- 操作门控：
|
||||
- 智能体工具支持包括 WhatsApp 反应动作（`react`）。
|
||||
- 动作开关：
|
||||
- `channels.whatsapp.actions.reactions`
|
||||
- `channels.whatsapp.actions.polls`
|
||||
- 默认启用由渠道发起的配置写入（可通过 `channels.whatsapp.configWrites=false` 禁用）。
|
||||
- 默认启用渠道发起的配置写入（可通过 `channels.whatsapp.configWrites=false` 禁用）。
|
||||
|
||||
## 故障排除
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="未关联（需要 QR 码）">
|
||||
症状：渠道状态显示未关联。
|
||||
症状：渠道状态报告为未关联。
|
||||
|
||||
修复：
|
||||
|
||||
@ -512,7 +512,9 @@ Ack 反应受 `reactionLevel` 控制——当 `reactionLevel` 为 `"off"` 时会
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="已关联但已断开 / 重连循环">
|
||||
症状：账号已关联，但反复断开或重复尝试重连。
|
||||
症状：已关联账户反复断开或重复尝试重连。
|
||||
|
||||
安静的账户可以在正常消息超时之后继续保持连接；当 WhatsApp Web 传输活动停止、socket 关闭，或应用层活动在更长的安全窗口之外仍保持静默时，看门狗会重启。
|
||||
|
||||
修复：
|
||||
|
||||
@ -525,57 +527,57 @@ Ack 反应受 `reactionLevel` 控制——当 `reactionLevel` 为 `"off"` 时会
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="发送时没有活跃监听器">
|
||||
当目标账号不存在活跃的 Gateway 网关监听器时，出站发送会快速失败。
|
||||
<Accordion title="发送时没有活动监听器">
|
||||
当目标账户不存在活动中的 Gateway 网关监听器时，出站发送会快速失败。
|
||||
|
||||
请确认 Gateway 网关正在运行，并且该账号已关联。
|
||||
请确认 Gateway 网关正在运行，并且该账户已关联。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="群组消息意外被忽略">
|
||||
请按以下顺序检查：
|
||||
<Accordion title="群组消息被意外忽略">
|
||||
按以下顺序检查：
|
||||
|
||||
- `groupPolicy`
|
||||
- `groupAllowFrom` / `allowFrom`
|
||||
- `groups` 允许列表条目
|
||||
- `groups` allowlist 条目
|
||||
- 提及门控（`requireMention` + 提及模式）
|
||||
- `openclaw.json`（JSON5）中的重复键：后面的条目会覆盖前面的条目，因此每个作用域只保留一个 `groupPolicy`
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Bun 运行时警告">
|
||||
WhatsApp Gateway 网关运行时应使用 Node。Bun 被标记为与稳定的 WhatsApp / Telegram Gateway 网关运行不兼容。
|
||||
WhatsApp Gateway 网关运行时应使用 Node。Bun 被标记为与稳定的 WhatsApp/Telegram Gateway 网关运行不兼容。
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## 系统提示词
|
||||
|
||||
WhatsApp 通过 `groups` 和 `direct` 映射支持 Telegram 风格的群组和直接聊天系统提示词。
|
||||
WhatsApp 支持类似 Telegram 的群组和直接聊天系统提示词，通过 `groups` 和 `direct` 映射进行配置。
|
||||
|
||||
群组消息的解析层级：
|
||||
|
||||
首先确定生效的 `groups` 映射：如果账号定义了自己的 `groups`，它会完全替换根级 `groups` 映射（不进行深度合并）。随后会在得到的单一映射上执行提示词查找：
|
||||
首先确定生效的 `groups` 映射：如果账户定义了自己的 `groups`，它会完全替换根级 `groups` 映射（不进行深度合并）。然后提示词查找会在这个最终得到的单一映射上运行：
|
||||
|
||||
1. **群组特定系统提示词**（`groups["<groupId>"].systemPrompt`）：当映射中存在该特定群组条目，且其定义了 `systemPrompt` 键时使用。如果 `systemPrompt` 是空字符串（`""`），则会抑制通配符，并且不应用任何系统提示词。
|
||||
2. **群组通配符系统提示词**（`groups["*"].systemPrompt`）：当映射中完全不存在该特定群组条目，或者该条目存在但未定义 `systemPrompt` 键时使用。
|
||||
1. **群组专用系统提示词**（`groups["<groupId>"].systemPrompt`）：当映射中存在该特定群组条目，**且**其 `systemPrompt` 键已定义时使用。如果 `systemPrompt` 是空字符串（`""`），则会抑制通配符，且不会应用任何系统提示词。
|
||||
2. **群组通配符系统提示词**（`groups["*"].systemPrompt`）：当映射中完全不存在该特定群组条目，或该条目存在但未定义 `systemPrompt` 键时使用。
|
||||
|
||||
直接消息的解析层级：
|
||||
私信的解析层级：
|
||||
|
||||
首先确定生效的 `direct` 映射：如果账号定义了自己的 `direct`，它会完全替换根级 `direct` 映射（不进行深度合并）。随后会在得到的单一映射上执行提示词查找：
|
||||
首先确定生效的 `direct` 映射：如果账户定义了自己的 `direct`，它会完全替换根级 `direct` 映射（不进行深度合并）。然后提示词查找会在这个最终得到的单一映射上运行：
|
||||
|
||||
1. **直接消息特定系统提示词**（`direct["<peerId>"].systemPrompt`）：当映射中存在该特定对端条目，且其定义了 `systemPrompt` 键时使用。如果 `systemPrompt` 是空字符串（`""`），则会抑制通配符，并且不应用任何系统提示词。
|
||||
2. **直接消息通配符系统提示词**（`direct["*"].systemPrompt`）：当映射中完全不存在该特定对端条目，或者该条目存在但未定义 `systemPrompt` 键时使用。
|
||||
1. **私信专用系统提示词**（`direct["<peerId>"].systemPrompt`）：当映射中存在该特定对端条目，**且**其 `systemPrompt` 键已定义时使用。如果 `systemPrompt` 是空字符串（`""`），则会抑制通配符，且不会应用任何系统提示词。
|
||||
2. **私信通配符系统提示词**（`direct["*"].systemPrompt`）：当映射中完全不存在该特定对端条目，或该条目存在但未定义 `systemPrompt` 键时使用。
|
||||
|
||||
注意：`dms` 仍然是轻量级的按私信历史覆盖桶（`dms.<id>.historyLimit`）；提示词覆盖位于 `direct` 下。
|
||||
注意：`dms` 仍然是轻量级的按私信历史覆盖容器（`dms.<id>.historyLimit`）；提示词覆盖位于 `direct` 下。
|
||||
|
||||
**与 Telegram 多账号行为的区别：** 在 Telegram 中，在多账号设置下，根级 `groups` 会被有意抑制——即使某些账号没有定义自己的 `groups` 也是如此——以防止某个机器人接收到它不属于的群组消息。WhatsApp 不应用这一保护：无论配置了多少账号，未定义账号级覆盖的账号始终会继承根级 `groups` 和根级 `direct`。在多账号 WhatsApp 设置中，如果你希望为每个账号设置单独的群组或直接消息提示词，请在每个账号下显式定义完整映射，而不要依赖根级默认值。
|
||||
**与 Telegram 多账户行为的区别：** 在 Telegram 中，在多账户设置下，根级 `groups` 会被有意抑制——即使某些账户没有定义自己的 `groups` 也是如此——以防止机器人接收其未加入群组的消息。WhatsApp 不应用这一保护：无论配置了多少个账户，凡是未定义账户级覆盖的账户，都会始终继承根级 `groups` 和根级 `direct`。在多账户 WhatsApp 设置中，如果你希望为每个账户单独设置群组或私信提示词，请在每个账户下显式定义完整映射，而不要依赖根级默认值。
|
||||
|
||||
重要行为：
|
||||
|
||||
- `channels.whatsapp.groups` 既是按群组的配置映射，也是聊天级群组允许列表。在根级或账号级作用域中，`groups["*"]` 表示该作用域“允许所有群组接入”。
|
||||
- 只有当你本来就希望该作用域允许所有群组时，才添加通配符群组 `systemPrompt`。如果你仍然只希望固定的一组群组 id 有资格接入，请不要使用 `groups["*"]` 作为提示词默认值。相反，请在每个显式加入允许列表的群组条目上重复该提示词。
|
||||
- 群组接入和发送者授权是两个独立检查。`groups["*"]` 会扩大可进入群组处理的群组集合，但它本身不会授权这些群组中的所有发送者。发送者访问仍由 `channels.whatsapp.groupPolicy` 和 `channels.whatsapp.groupAllowFrom` 单独控制。
|
||||
- `channels.whatsapp.direct` 对私信没有同样的副作用。`direct["*"]` 仅在某个私信已经通过 `dmPolicy` 加 `allowFrom` 或配对存储规则被允许后，才提供默认的直接聊天配置。
|
||||
- `channels.whatsapp.groups` 既是按群组配置的映射，也是聊天级群组 allowlist。在根级或账户作用域中，`groups["*"]` 都表示“该作用域下允许所有群组”。
|
||||
- 仅当你本来就希望该作用域允许所有群组时，才添加通配符群组 `systemPrompt`。如果你仍然只希望固定的一组群组 id 有资格被处理，就不要将 `groups["*"]` 用作默认提示词。相反，应在每个显式加入 allowlist 的群组条目上重复该提示词。
|
||||
- 群组准入和发送者授权是两个独立检查。`groups["*"]` 会扩大可以进入群组处理流程的群组集合，但它本身并不会授权这些群组中的所有发送者。发送者访问仍然单独由 `channels.whatsapp.groupPolicy` 和 `channels.whatsapp.groupAllowFrom` 控制。
|
||||
- `channels.whatsapp.direct` 对私信没有同样的副作用。`direct["*"]` 只会在某条私信已经通过 `dmPolicy` 加上 `allowFrom` 或配对存储规则而获准后，提供默认的直接聊天配置。
|
||||
|
||||
示例：
|
||||
|
||||
@ -584,30 +586,30 @@ WhatsApp 通过 `groups` 和 `direct` 映射支持 Telegram 风格的群组和
|
||||
channels: {
|
||||
whatsapp: {
|
||||
groups: {
|
||||
// 仅当根级作用域应允许所有群组时使用。
|
||||
// 适用于所有未定义自己 groups 映射的账号。
|
||||
// 仅当根级作用域下应允许所有群组时才使用。
|
||||
// 适用于所有未定义自己 groups 映射的账户。
|
||||
"*": { systemPrompt: "所有群组的默认提示词。" },
|
||||
},
|
||||
direct: {
|
||||
// 适用于所有未定义自己 direct 映射的账号。
|
||||
// 适用于所有未定义自己 direct 映射的账户。
|
||||
"*": { systemPrompt: "所有直接聊天的默认提示词。" },
|
||||
},
|
||||
accounts: {
|
||||
work: {
|
||||
groups: {
|
||||
// 此账号定义了自己的 groups，因此根级 groups 会被完全
|
||||
// 替换。若要保留通配符，也需要在这里显式定义 "*"。
|
||||
// 该账户定义了自己的 groups，因此根级 groups 会被完全
|
||||
// 替换。若要保留通配符，也需要在此显式定义 "*"。
|
||||
"120363406415684625@g.us": {
|
||||
requireMention: false,
|
||||
systemPrompt: "聚焦项目管理。",
|
||||
systemPrompt: "专注于项目管理。",
|
||||
},
|
||||
// 仅当此账号应允许所有群组时使用。
|
||||
// 仅当该账户下应允许所有群组时才使用。
|
||||
"*": { systemPrompt: "工作群组的默认提示词。" },
|
||||
},
|
||||
direct: {
|
||||
// 此账号定义了自己的 direct 映射，因此根级 direct 条目会被
|
||||
// 完全替换。若要保留通配符，也需要在这里显式定义 "*"。
|
||||
"+15551234567": { systemPrompt: "特定工作直接聊天的提示词。" },
|
||||
// 该账户定义了自己的 direct 映射，因此根级 direct 条目会被
|
||||
// 完全替换。若要保留通配符，也需要在此显式定义 "*"。
|
||||
"+15551234567": { systemPrompt: "特定工作私聊的提示词。" },
|
||||
"*": { systemPrompt: "工作直接聊天的默认提示词。" },
|
||||
},
|
||||
},
|
||||
@ -623,11 +625,11 @@ WhatsApp 通过 `groups` 和 `direct` 映射支持 Telegram 风格的群组和
|
||||
|
||||
- [配置参考 - WhatsApp](/zh-CN/gateway/config-channels#whatsapp)
|
||||
|
||||
高信号 WhatsApp 字段：
|
||||
高信号的 WhatsApp 字段：
|
||||
|
||||
- 访问控制：`dmPolicy`、`allowFrom`、`groupPolicy`、`groupAllowFrom`、`groups`
|
||||
- 访问：`dmPolicy`、`allowFrom`、`groupPolicy`、`groupAllowFrom`、`groups`
|
||||
- 投递：`textChunkLimit`、`chunkMode`、`mediaMaxMb`、`sendReadReceipts`、`ackReaction`、`reactionLevel`
|
||||
- 多账号：`accounts.<id>.enabled`、`accounts.<id>.authDir`、账号级覆盖
|
||||
- 多账户：`accounts.<id>.enabled`、`accounts.<id>.authDir`、账户级覆盖
|
||||
- 运维：`configWrites`、`debounceMs`、`web.enabled`、`web.heartbeatSeconds`、`web.reconnect.*`
|
||||
- 会话行为：`session.dmScope`、`historyLimit`、`dmHistoryLimit`、`dms.<id>.historyLimit`
|
||||
- 提示词：`groups.<id>.systemPrompt`、`groups["*"].systemPrompt`、`direct.<id>.systemPrompt`、`direct["*"].systemPrompt`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user