BlueBubbles(macOS REST)

状态:捆绑插件,通过 HTTP 与 BlueBubbles macOS 服务器通信。由于其更丰富的 API 和比传统 imsg 通道更简单的设置,推荐用于 iMessage 集成

概述

  • 通过 BlueBubbles 辅助应用在 macOS 上运行(bluebubbles.app)。
  • 推荐/测试:macOS Sequoia (15)。macOS Tahoe (26) 可用;编辑功能目前在 Tahoe 上损坏,群组图标更新可能报告成功但不同步。
  • OpenClaw 通过 REST API 与之通信(GET /api/v1/pingPOST /message/textPOST /chat/:id/*)。
  • 传入消息通过 webhook 到达;传出回复、输入指示符、已读回执和点击回执通过 REST 调用。
  • 附件和贴纸作为入站媒体摄取(并在可能的情况下向代理公开)。
  • 配对/允许列表与其他通道(/channels/pairing 等)相同的方式工作,使用 channels.bluebubbles.allowFrom + 配对代码。
  • 反应就像 Slack/Telegram 一样作为系统事件公开,以便代理在回复前可以”提及”它们。
  • 高级功能:编辑、取消发送、回复线程、消息效果、群组管理。

快速开始

  1. 在您的 Mac 上安装 BlueBubbles 服务器(按照 bluebubbles.app/install 的说明操作)。

  2. 在 BlueBubbles 配置中,启用 web API 并设置密码。

  3. 运行 openclaw onboard 并选择 BlueBubbles,或手动配置:

    {
      channels: {
        bluebubbles: {
          enabled: true,
          serverUrl: "http://192.168.1.100:1234",
          password: "example-password",
          webhookPath: "/bluebubbles-webhook",
        },
      },
    }
  4. 将 BlueBubbles webhooks 指向您的 gateway(例如:https://your-gateway-host:3000/bluebubbles-webhook?password=<password>)。

  5. 启动 gateway;它将注册 webhook 处理器并开始配对。

安全说明:

  • 始终设置 webhook 密码。
  • 始终需要 webhook 身份验证。OpenClaw 拒绝除非包含与 channels.bluebubbles.password 匹配的密码/guid 的 BlueBubbles webhook 请求(例如 ?password=<password>x-password),无论回环/代理拓扑如何。

保持 Messages.app 处于活动状态(VM / 无头设置)

某些 mac VM / 始终在线设置可能导致 Messages.app 处于”空闲”状态(传入事件停止,直到应用被打开/前台)。一个简单的解决方法是:每 5 分钟戳一下 Messages,使用 AppleScript + LaunchAgent。

1) 保存 AppleScript

保存为:

  • ~/Scripts/poke-messages.scpt

示例脚本(非交互式;不会抢占焦点):

try
  tell application "Messages"
    if not running then
      launch
    end if

    -- Touch the scripting interface to keep the process responsive.
    set _chatCount to (count of chats)
  end tell
on error
  -- Ignore transient failures (first-run prompts, locked session, etc).
end try

2) 安装 LaunchAgent

保存为:

  • ~/Library/LaunchAgents/com.user.poke-messages.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>Label</key>
    <string>com.user.poke-messages</string>

    <key>ProgramArguments</key>
    <array>
      <string>/bin/bash</string>
      <string>-lc</string>
      <string>/usr/bin/osascript "$HOME/Scripts/poke-messages.scpt"</string>
    </array>

    <key>RunAtLoad</key>
    <true/>

    <key>StartInterval</key>
    <integer>300</integer>

    <key>StandardOutPath</key>
    <string>/tmp/poke-messages.log</string>
    <key>StandardErrorPath</key>
    <string>/tmp/poke-messages.err</string>
  </dict>
</plist>

注意:

  • 这每 300 秒运行一次,登录时运行。
  • 首次运行可能会触发 macOS Automation 提示(osascript → Messages)。在与运行 LaunchAgent 的同一用户会话中批准它们。

加载它:

launchctl unload ~/Library/LaunchAgents/com.user.poke-messages.plist 2>/dev/null || true
launchctl load ~/Library/LaunchAgents/com.user.poke-messages.plist

入门

BlueBubbles 在交互式设置向导中可用:

openclaw onboard

向导提示:

  • 服务器 URL(必需):BlueBubbles 服务器地址(例如 http://192.168.1.100:1234
  • 密码(必需):BlueBubbles 服务器设置中的 API 密码
  • Webhook 路径(可选):默认为 /bluebubbles-webhook
  • DM 策略:配对、允许列表、开放或禁用
  • 允许列表:电话号码、电子邮件或聊天目标

您也可以通过 CLI 添加 BlueBubbles:

openclaw channels add bluebubbles --http-url http://192.168.1.100:1234 --password <password>

访问控制(DM + 群组)

DM:

  • 默认:channels.bluebubbles.dmPolicy = "pairing"
  • 未知发送者收到配对代码;消息在批准之前被忽略(代码 1 小时后过期)。
  • 通过以下方式批准:
    • openclaw pairing list bluebubbles
    • openclaw 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 时,代理仅在收到提及时回复。
  • 来自授权发送者的控制命令绕过提及门控。

每个群组配置:

{
  channels: {
    bluebubbles: {
      groupPolicy: "allowlist",
      groupAllowFrom: ["+15555550123"],
      groups: {
        "*": { requireMention: true }, // 所有群组的默认
        "iMessage;-;chat123": { requireMention: false }, // 特定群组的覆盖
      },
    },
  },
}

命令门控

  • 控制命令(例如 /config/model)需要授权。
  • 使用 allowFromgroupAllowFrom 确定命令授权。
  • 授权发送者即使在群组中未提及也可以运行控制命令。

输入 + 已读回执

  • 输入指示符:在响应生成之前和期间自动发送。
  • 已读回执:由 channels.bluebubbles.sendReadReceipts 控制(默认:true)。
  • 输入指示符:OpenClaw 发送输入开始事件;BlueBubbles 在发送或超时时自动清除输入(通过 DELETE 手动停止不可靠)。
{
  channels: {
    bluebubbles: {
      sendReadReceipts: false, // 禁用已读回执
    },
  },
}

高级操作

在配置中启用时,BlueBubbles 支持高级消息操作:

{
  channels: {
    bluebubbles: {
      actions: {
        reactions: true, // 点击回执(默认:true)
        edit: true, // 编辑已发送的消息(macOS 13+,在 macOS 26 Tahoe 上损坏)
        unsend: true, // 取消发送消息(macOS 13+)
        reply: true, // 通过消息 GUID 进行回复线程
        sendWithEffect: true, // 消息效果(slam、loud 等)
        renameGroup: true, // 重命名群组聊天
        setGroupIcon: true, // 设置群组聊天图标/照片(macOS 26 Tahoe 上不稳定)
        addParticipant: true, // 添加参与者到群组
        removeParticipant: true, // 从群组中移除参与者
        leaveGroup: true, // 离开群组聊天
        sendAttachment: true, // 发送附件/媒体
      },
    },
  },
}

可用操作:

  • react:添加/移除点击回执反应(messageIdemojiremove
  • edit:编辑已发送的消息(messageIdtext
  • unsend:取消发送消息(messageId
  • reply:回复特定消息(messageIdtextto
  • sendWithEffect:使用 iMessage 效果发送(texttoeffectId
  • renameGroup:重命名群组聊天(chatGuiddisplayName
  • setGroupIcon:设置群组聊天的图标/照片(chatGuidmedia)— 在 macOS 26 Tahoe 上不稳定(API 可能返回成功但图标不同步)
  • addParticipant:将某人添加到群组(chatGuidaddress
  • removeParticipant:从群组中移除某人(chatGuidaddress
  • leaveGroup:离开群组聊天(chatGuid
  • sendAttachment:发送媒体/文件(tobufferfilenameasVoice
    • 语音备忘录:设置 asVoice: true 并使用 MP3CAF 音频作为 iMessage 语音消息发送。BlueBubbles 在发送语音备忘录时将 MP3 转换为 CAF。

消息 ID(短 vs 完整)

OpenClaw 可能会公开_短_消息 ID(例如 12)以节省 token:

  • MessageSid / ReplyToId 可以是短 ID。
  • MessageSidFull / ReplyToIdFull 包含提供商的完整 ID。
  • 短 ID 存在于内存中;它们可能在重启或缓存清除时过期。
  • 操作接受短或完整的 messageId,但如果没有可用的短 ID 会报错。

将完整 ID 用于持久自动化和存储:

  • 模板:{{MessageSidFull}}{{ReplyToIdFull}}
  • 上下文:入站负载中的 MessageSidFull / ReplyToIdFull

请参阅配置了解模板变量。

块流式传输

控制响应是作为单条消息发送还是以块流式传输:

{
  channels: {
    bluebubbles: {
      blockStreaming: true, // 启用块流式传输(默认关闭)
    },
  },
}

媒体 + 限制

  • 入站附件下载并存储在媒体缓存中。
  • 媒体上限通过 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.dmPolicypairing | allowlist | open | disabled(默认:pairing)。
  • channels.bluebubbles.allowFrom:DM 允许列表(句柄、电子邮件、E.164 号码、chat_id:*chat_guid:*)。
  • channels.bluebubbles.groupPolicyopen | allowlist | disabled(默认:allowlist)。
  • channels.bluebubbles.groupAllowFrom:群组发送者允许列表。
  • channels.bluebubbles.groups:每个群组配置(requireMention 等)。
  • channels.bluebubbles.sendReadReceipts:发送已读回执(默认:true)。
  • channels.bluebubbles.blockStreaming:启用块流式传输(默认:false;流式回复需要)。
  • channels.bluebubbles.textChunkLimit:出站分块大小(字符,默认:4000)。
  • channels.bluebubbles.chunkModelength(默认)仅在超过 textChunkLimit 时分块;newline 在长度分块前按空行(段落边界)分块。
  • channels.bluebubbles.mediaMaxMb:入站媒体上限(MB,默认:8)。
  • channels.bluebubbles.mediaLocalRoots:允许出站本地媒体路径的绝对本地目录显式允许列表。默认情况下拒绝本地路径发送,除非配置了这项。每个账户覆盖:channels.bluebubbles.accounts.<accountId>.mediaLocalRoots
  • channels.bluebubbles.historyLimit:上下文的最大群组消息数(0 禁用)。
  • channels.bluebubbles.dmHistoryLimit:DM 历史限制。
  • channels.bluebubbles.actions:启用/禁用特定操作。
  • channels.bluebubbles.accounts:多账户配置。

相关全局选项:

  • agents.list[].groupChat.mentionPatterns(或 messages.groupChat.mentionPatterns)。
  • messages.responsePrefix

寻址/投递目标

优先使用 chat_guid 以获得稳定的路由:

  • chat_guid:iMessage;-;+15555550123(群组首选)
  • chat_id:123
  • chat_identifier:...
  • 直接句柄:+15555550123[email protected]
    • 如果直接句柄没有现有的 DM 聊天,OpenClaw 将通过 POST /api/v1/chat/new 创建一个。这需要启用 BlueBubbles Private API。

安全

  • Webhook 请求通过将 guid/password 查询参数或标头与 channels.bluebubbles.password 进行比较来验证身份验证。也接受来自 localhost 的请求。
  • 保持 API 密码和 webhook 端点机密(像对待凭证一样)。
  • 本地信任意味着同一主机反向代理可能会无意中绕过密码。如果您代理 gateway,请在代理处要求身份验证,并配置 gateway.trustedProxies。请参阅 Gateway 安全
  • 如果在 LAN 外部暴露 BlueBubbles 服务器,请启用 HTTPS + 防火墙规则。

排查

  • 如果输入/读取事件停止工作,请检查 BlueBubbles webhook 日志并验证 gateway 路径与 channels.bluebubbles.webhookPath 匹配。
  • 配对代码 1 小时后过期;使用 openclaw pairing list bluebubblesopenclaw 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 --allopenclaw status --deep

有关一般通道工作流程参考,请参阅通道插件指南。