BlueBubbles(macOS REST)
状态:通过 HTTP 与 BlueBubbles macOS 服务器通信的内置插件。推荐用于 iMessage 集成,因为与旧版 imsg 渠道相比,它的 API 更丰富,设置也更简单。内置插件
当前的 OpenClaw 版本内置了 BlueBubbles,因此普通打包构建不需要单独执行openclaw plugins install 步骤。
概览
- 通过 BlueBubbles 辅助应用在 macOS 上运行(bluebubbles.app)。
- 推荐/测试环境:macOS Sequoia(15)。macOS Tahoe(26)可用;当前在 Tahoe 上编辑功能不可用,群组图标更新也可能显示成功但不会同步。
- OpenClaw 通过其 REST API 与其通信(
GET /api/v1/ping、POST /message/text、POST /chat/:id/*)。 - 传入消息通过 webhook 到达;传出回复、输入状态、已读回执和 tapback 回应通过 REST 调用发送。
- 附件和贴纸会作为传入媒体接收(并在可能时提供给智能体)。
- 配对/allowlist 的工作方式与其他渠道相同(
/channels/pairing等),使用channels.bluebubbles.allowFrom+ 配对码。 - 回应会像 Slack/Telegram 一样作为系统事件呈现,因此智能体可以在回复前“提及”它们。
- 高级功能:编辑、撤回、回复线程、消息效果、群组管理。
快速开始
- 在你的 Mac 上安装 BlueBubbles 服务器(按照 bluebubbles.app/install 的说明进行)。
- 在 BlueBubbles 配置中启用 Web API,并设置密码。
-
运行
openclaw onboard并选择 BlueBubbles,或手动配置: -
将 BlueBubbles webhook 指向你的 Gateway 网关(示例:
https://your-gateway-host:3000/bluebubbles-webhook?password=<password>)。 - 启动 Gateway 网关;它会注册 webhook 处理器并开始配对。
- 始终设置 webhook 密码。
- 始终要求进行 webhook 身份验证。OpenClaw 会拒绝 BlueBubbles webhook 请求,除非它们包含与
channels.bluebubbles.password匹配的 password/guid(例如?password=<password>或x-password),无论 loopback/proxy 拓扑如何。 - 在读取/解析完整 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→ Messages)。请在运行该 LaunchAgent 的同一用户会话中批准它们。
新手引导
BlueBubbles 可在交互式新手引导中使用:- Server URL(必填):BlueBubbles 服务器地址(例如
http://192.168.1.100:1234) - Password(必填):BlueBubbles Server 设置中的 API 密码
- Webhook path(可选):默认为
/bluebubbles-webhook - DM 策略:pairing、allowlist、open 或 disabled
- 允许列表:电话号码、电子邮件地址或聊天目标
访问控制(私信 + 群组)
私信:- 默认值:
channels.bluebubbles.dmPolicy = "pairing"。 - 未知发送者会收到一个配对码;在获批前其消息会被忽略(配对码 1 小时后过期)。
- 通过以下方式批准:
openclaw pairing list bluebubblesopenclaw pairing approve bluebubbles <CODE>
- 配对是默认的令牌交换方式。详情请参见:配对
channels.bluebubbles.groupPolicy = open | allowlist | disabled(默认值:allowlist)。- 当设置为
allowlist时,channels.bluebubbles.groupAllowFrom用于控制哪些人可以在群组中触发。
联系人姓名增强(macOS,可选)
BlueBubbles 群组 webhook 通常只包含原始参与者地址。如果你希望GroupMembers 上下文改为显示本地联系人名称,可以在 macOS 上选择启用本地通讯录增强:
channels.bluebubbles.enrichGroupParticipantsFromContacts = true启用查找。默认值:false。- 只有在群组访问、命令授权和提及门控都允许消息通过之后,才会执行查找。
- 仅增强未命名的电话参与者。
- 如果未找到本地匹配项,仍会回退为原始电话号码。
提及门控(群组)
BlueBubbles 支持群聊提及门控,与 iMessage/WhatsApp 的行为一致:- 使用
agents.list[].groupChat.mentionPatterns(或messages.groupChat.mentionPatterns)检测提及。 - 当某个群组启用了
requireMention时,智能体只会在被提及时响应。 - 来自已授权发送者的控制命令会绕过提及门控。
命令门控
- 控制命令(例如
/config、/model)需要授权。 - 使用
allowFrom和groupAllowFrom来确定命令授权。 - 已授权发送者即使在群组中未提及,也可以运行控制命令。
ACP 会话绑定
BlueBubbles 聊天可以转换为持久化 ACP 工作区,而无需更改传输层。 快速操作流程:- 在私信或允许的群聊中运行
/acp spawn codex --bind here。 - 该 BlueBubbles 会话中的后续消息会路由到已派生的 ACP 会话。
/new和/reset会就地重置同一个已绑定的 ACP 会话。/acp close会关闭 ACP 会话并移除绑定。
bindings[] 条目配置持久化绑定,使用 type: "acp" 和 match.channel: "bluebubbles"。
match.peer.id 可以使用任何受支持的 BlueBubbles 目标格式:
- 规范化的私信句柄,例如
+15555550123或user@example.com chat_id:<id>chat_guid:<guid>chat_identifier:<identifier>
chat_id:* 或 chat_identifier:*。
示例:
输入状态 + 已读回执
- 输入状态指示器:在回复生成前和生成期间自动发送。
- 已读回执:由
channels.bluebubbles.sendReadReceipts控制(默认值:true)。 - 输入状态指示器:OpenClaw 会发送输入开始事件;BlueBubbles 会在发送后或超时后自动清除输入状态(通过 DELETE 手动停止并不可靠)。
高级操作
当在配置中启用时,BlueBubbles 支持高级消息操作:- react:添加/移除 tapback 回应(
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) - upload-file:发送媒体/文件(
to、buffer、filename、asVoice)- 语音备忘录:将 MP3 或 CAF 音频与
asVoice: true搭配使用,以 iMessage 语音消息形式发送。BlueBubbles 在发送语音备忘录时会将 MP3 转换为 CAF。
- 语音备忘录:将 MP3 或 CAF 音频与
- 旧别名:
sendAttachment仍然可用,但upload-file是规范操作名称。
消息 ID(短 ID 与完整 ID)
OpenClaw 可能会显示_短_消息 ID(例如1、2)以节省 token。
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:私信 allowlist(句柄、电子邮件、E.164 号码、chat_id:*、chat_guid:*)。channels.bluebubbles.groupPolicy:open | allowlist | disabled(默认值:allowlist)。channels.bluebubbles.groupAllowFrom:群组发送者 allowlist。channels.bluebubbles.enrichGroupParticipantsFromContacts:在 macOS 上,在门控通过后可选择从本地通讯录增强未命名的群组参与者。默认值:false。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:允许用于传出本地媒体路径的绝对本地目录显式 allowlist。默认拒绝发送本地路径,除非配置此项。按账户覆盖: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 Private API。
- 如果直接句柄还没有现有私信聊天,OpenClaw 会通过
安全
- Webhook 请求通过将查询参数或请求头中的
guid/password与channels.bluebubbles.password比较来进行身份验证。 - 请妥善保管 API 密码和 webhook 端点机密(将它们视为凭证)。
- BlueBubbles webhook 身份验证没有 localhost 绕过。如果你代理 webhook 流量,请在整个请求链路中保留 BlueBubbles 密码。这里的
gateway.trustedProxies不能替代channels.bluebubbles.password。请参见 Gateway 安全。 - 如果要在 LAN 之外暴露 BlueBubbles 服务器,请启用 HTTPS + 防火墙规则。
故障排除
- 如果输入状态/已读事件停止工作,请检查 BlueBubbles webhook 日志,并确认 Gateway 网关路径与
channels.bluebubbles.webhookPath匹配。 - 配对码会在一小时后过期;使用
openclaw pairing list bluebubbles和openclaw pairing approve bluebubbles <code>。 - 回应需要 BlueBubbles private API(
POST /api/v1/message/react);请确认服务器版本提供该接口。 - 编辑/撤回需要 macOS 13+ 和兼容的 BlueBubbles 服务器版本。在 macOS 26(Tahoe)上,由于 private API 变更,编辑当前不可用。
- 群组图标更新在 macOS 26(Tahoe)上可能不稳定:API 可能返回成功,但新图标不会同步。
- OpenClaw 会根据 BlueBubbles 服务器的 macOS 版本自动隐藏已知不可用的操作。如果在 macOS 26(Tahoe)上仍显示编辑功能,请手动通过
channels.bluebubbles.actions.edit=false禁用它。 - 状态/健康信息请使用:
openclaw status --all或openclaw status --deep。