BlueBubbles (macOS REST)
状态:内置插件,通过 HTTP 与 BlueBubbles macOS 服务器通信。由于其拥有更丰富的 API 且相比旧版 imsg 渠道 设置更简单,推荐用于 iMessage 集成。概览
- 通过 macOS 上的 BlueBubbles 辅助应用程序 (bluebubbles.app) 运行。
- 推荐/测试版本:macOS Sequoia (15)。macOS Tahoe (26) 可用;但在 Tahoe 上编辑功能目前有问题,且群组图标更新可能报告成功但实际上未同步。
- OpenClaw 通过其 REST API (
GET /api/v1/ping,POST /message/text,POST /chat/:id/*) 与其通信。 - 传入消息通过 webhook 到达;传出回复、正在输入指示器、已读回执和轻点是 REST 调用。
- 附件和贴纸作为入站媒体接收(并尽可能显示给代理)。
- 配对/允许列表的工作方式与其他通道相同(
/channels/pairing等),并结合channels.bluebubbles.allowFrom+ 配对码。 - 回应作为系统事件呈现,就像 Slack/Telegram 一样,以便代理可以在回复前“提及”它们。
- 高级功能:编辑、撤销发送、回复串接、消息效果、群组管理。
快速开始
- 在您的 Mac 上安装 BlueBubbles 服务器(请遵循 bluebubbles.app/install 上的说明)。
- 在 BlueBubbles 配置中,启用 Web API 并设置密码。
-
运行
openclaw onboard并选择 BlueBubbles,或手动配置: -
将 BlueBubbles webhooks 指向您的网关(例如:
https://your-gateway-host:3000/bluebubbles-webhook?password=<password>)。 - 启动网关;它将注册 webhook 处理程序并开始配对。
- 务必设置 webhook 密码。
- 始终需要 Webhook 身份验证。除非 BlueBubbles webhook 请求包含与
channels.bluebubbles.password匹配的密码/guid(例如?password=<password>或x-password),否则 OpenClaw 将拒绝这些请求,无论回环/代理拓扑如何。 - 在读取/解析完整的 Webhook 主体之前会检查密码身份验证。
保持 Messages.app 活跃(VM / 无头设置)
某些 macOS VM / 常开设置可能会导致 Messages.app 进入“空闲”状态(传入事件停止,直到打开/激活应用程序)。一个简单的解决方法是使用 AppleScript + LaunchAgent 每 5 分钟唤醒一次 Messages。1) 保存 AppleScript
将其保存为:~/Scripts/poke-messages.scpt
2) 安装 LaunchAgent
将其保存为:~/Library/LaunchAgents/com.user.poke-messages.plist
- 这将在登录时以及每 300 秒运行一次。
- 首次运行可能会触发 macOS 自动化 提示(
osascript→ 信息)。请在运行 LaunchAgent 的同一用户会话中批准它们。
入门
BlueBubbles 在交互式新手引导中可用:- 服务器 URL(必填):BlueBubbles 服务器地址(例如
http://192.168.1.100:1234) - Password(必填):来自 BlueBubbles 服务器设置的 API 密码
- Webhook 路径(可选):默认为
/bluebubbles-webhook - 私信 policy(私聊策略):pairing(配对)、allowlist(白名单)、open(开放)或 disabled(禁用)
- Allow list(允许列表):电话号码、电子邮件或聊天目标
访问控制(私聊 + 群组)
私聊(私信):- 默认值:
channels.bluebubbles.dmPolicy = "pairing"。 - 未知发送者会收到配对码;消息在获得批准前将被忽略(代码在 1 小时后过期)。
- 通过以下方式批准:
openclaw pairing list bluebubblesopenclaw pairing approve bluebubbles <CODE>
- 配对是默认的令牌交换方式。详情:配对
channels.bluebubbles.groupPolicy = open | allowlist | disabled(默认值:allowlist)。channels.bluebubbles.groupAllowFrom控制当设置了allowlist时谁可以在群组中触发操作。
提及限制(群组)
BlueBubbles 支持群聊的提及控制,与 iMessage/WhatsApp 的行为相匹配:- 使用
agents.list[].groupChat.mentionPatterns(或messages.groupChat.mentionPatterns)来检测提及。 - 当为群组启用
requireMention时,代理仅在被提及时响应。 - 来自授权发送者的控制命令会绕过提及限制。
命令限制
- 控制命令(例如
/config、/model)需要授权。 - 使用
allowFrom和groupAllowFrom来确定命令授权。 - 授权发送者即使在群组中未进行提及也可以运行控制命令。
正在输入 + 已读回执
- 正在输入指示器:在生成响应之前和期间自动发送。
- 已读回执:由
channels.bluebubbles.sendReadReceipts控制(默认值:true)。 - 输入指示器:OpenClaw 发送输入开始事件;BlueBubbles 会在发送或超时时自动清除输入状态(通过 DELETE 手动停止是不可靠的)。
高级操作
在配置中启用后,BlueBubbles 支持高级消息操作:- react:添加/删除点按反应(
messageId、emoji、remove) - edit:编辑已发送的消息(
messageId、text) - unsend:撤回一条消息 (
messageId) - reply:回复特定消息 (
messageId,text,to) - sendWithEffect:带 iMessage 特效发送 (
text,to,effectId) - renameGroup:重命名群聊 (
chatGuid,displayName) - setGroupIcon:设置群聊图标/照片 (
chatGuid,media) — 在 macOS 26 Tahoe 上不稳定(API 可能返回成功但图标未同步)。 - addParticipant:添加某人到群组 (
chatGuid,address) - removeParticipant:从群组移除某人 (
chatGuid,address) - leaveGroup:退出群聊 (
chatGuid) - sendAttachment:发送媒体/文件 (
to,buffer,filename,asVoice)- 语音备忘录:设置
asVoice: true为 MP3 或 CAF 音频以作为 iMessage 语音消息发送。BlueBubbles 在发送语音备忘录时会将 MP3 转换为 CAF。
- 语音备忘录:设置
消息 ID(短 ID vs 完整 ID)
OpenClaw 可能会显示 短 消息 ID(例如1, 2) 以节省令牌。
MessageSid/ReplyToId可以是短 ID。MessageSidFull/ReplyToIdFull包含提供商的完整 ID。- 短 ID 存储在内存中;它们可能会在重启或缓存清除时失效。
- 操作接受短 ID 或完整
messageId,但如果短 ID 不再可用,则会报错。
- 模板:
{{MessageSidFull}},{{ReplyToIdFull}} - 入站载荷中
MessageSidFull/ReplyToIdFull的上下文
分块流式传输
控制响应是作为单条消息发送还是以流式分块发送:媒体与限制
- 入站附件会被下载并存储在媒体缓存中。
- 通过
channels.bluebubbles.mediaMaxMb设置入站和出站媒体的媒体上限(默认:8 MB)。 - 出站文本会被分块为
channels.bluebubbles.textChunkLimit(默认:4000 个字符)。
配置参考
完整配置:配置 提供商选项:channels.bluebubbles.enabled: 启用/禁用渠道。channels.bluebubbles.serverUrl:BlueBubbles REST API 基础 URL。channels.bluebubbles.password:API 密码。channels.bluebubbles.webhookPath: Webhook 端点路径(默认:/bluebubbles-webhook)。channels.bluebubbles.dmPolicy:pairing | allowlist | open | disabled(默认:pairing)。channels.bluebubbles.allowFrom: 私信允许列表(标识符、电子邮件、E.164 号码、chat_id:*、chat_guid:*)。channels.bluebubbles.groupPolicy:open | allowlist | disabled(默认:allowlist)。channels.bluebubbles.groupAllowFrom: 群组发送者允许列表。channels.bluebubbles.groups: 每个群组的配置(requireMention等)。channels.bluebubbles.sendReadReceipts: 发送已读回执(默认:true)。channels.bluebubbles.blockStreaming: 启用分块流式传输(默认:false;流式回复所必需)。channels.bluebubbles.textChunkLimit: 出站字符分块大小(默认:4000)。channels.bluebubbles.chunkMode:length(默认)仅在超过textChunkLimit时拆分;newline在按长度分块之前在空行(段落边界)处拆分。channels.bluebubbles.mediaMaxMb:入站/出站媒体容量上限(MB,默认:8)。channels.bluebubbles.mediaLocalRoots:允许用于出站本地媒体路径的绝对本地目录的明确允许列表。除非配置此项,否则默认禁止本地路径发送。按账户覆盖:channels.bluebubbles.accounts.<accountId>.mediaLocalRoots。channels.bluebubbles.historyLimit:用于上下文的最大群组消息数(0 表示禁用)。channels.bluebubbles.dmHistoryLimit:私信历史记录限制。channels.bluebubbles.actions:启用/禁用特定操作。channels.bluebubbles.accounts:多账户配置。
agents.list[].groupChat.mentionPatterns(或messages.groupChat.mentionPatterns)。messages.responsePrefix。
寻址 / 投递目标
为保持路由稳定,建议使用chat_guid:
chat_guid:iMessage;-;+15555550123(群组首选)chat_id:123chat_identifier:...- 直接句柄:
+15555550123、user@example.com- 如果直接句柄没有现有的私信聊天,OpenClaw 将通过
POST /api/v1/chat/new创建一个。这需要启用 BlueBubbles 私有 API。
- 如果直接句柄没有现有的私信聊天,OpenClaw 将通过
安全性
- Webhook 请求通过将
guid/password查询参数或标头与channels.bluebubbles.password进行比较来验证。来自localhost的请求也被接受。 - 请妥善保管 API 密码和 webhook 端点(将它们视为凭据)。
- 本地主机信任意味着同主机反向代理可能会无意中绕过密码。如果您代理 Gateway(网关),请要求在代理处进行身份验证并配置
gateway.trustedProxies。请参阅 Gateway(网关) 安全性。 - 如果将 BlueBubbles 服务器暴露在局域网之外,请在其上启用 HTTPS 和防火墙规则。
故障排除
- 如果正在输入/已读事件停止工作,请检查 BlueBubbles webhook 日志并验证网关路径是否匹配
channels.bluebubbles.webhookPath。 - 配对码在一小时后过期;请使用
openclaw pairing list bluebubbles和openclaw pairing approve bluebubbles <code>。 - 表情回应需要 BlueBubbles 私有 API (
POST /api/v1/message/react);请确保服务器版本已将其公开。 - 编辑/取消发送需要 macOS 13+ 及兼容的 BlueBubbles 服务器版本。在 macOS 26 (Tahoe) 上,由于私有 API 的更改,编辑功能目前无法使用。
- 在 macOS 26 (Tahoe) 上,群组图标更新可能不稳定:API 可能会返回成功,但新图标未同步。
- OpenClaw 会根据 BlueBubbles 服务器的 macOS 版本自动隐藏已知损坏的操作。如果在 macOS 26 (Tahoe) 上仍然显示编辑选项,请使用
channels.bluebubbles.actions.edit=false手动将其禁用。 - 有关状态/运行状况的信息:
openclaw status --all或openclaw status --deep。
本页面源自 openclaw/openclaw,由 BeaversLab 翻译,遵循 MIT 协议 发布。