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/ping、POST /message/text、POST /chat/:id/*）。
  • 传入消息通过 webhook 到达；传出回复、输入指示器（typing indicators）、已读回执（read receipts）和点赞（tapbacks）是 REST 调用。
  • 附件和贴纸作为入站媒体摄取（并在可能的情况下呈现给代理）。
  • 配对/允许列表的工作方式与其他频道相同（/start/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 webhook 指向你的网关（示例：https://your-gateway-host:3000/bluebubbles-webhook?password=<password>）。
  5. 启动网关；它将注册 webhook 处理程序并开始配对。

入门向导（Onboarding）

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

openclaw onboard

向导提示输入：

  • Server URL（必需）：BlueBubbles 服务器地址（例如 http://192.168.1.100:1234）
  • Password（必需）：BlueBubbles Server 设置中的 API 密码
  • Webhook path（可选）：默认为 /bluebubbles-webhook
  • DM policy：pairing、allowlist、open 或 disabled
  • Allow list：电话号码、电子邮件或聊天目标

你也可以通过 CLI 添加 BlueBubbles：

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

访问控制（私信 + 群组）

私信（DMs）：

  • 默认：channels.bluebubbles.dmPolicy = "pairing"。
  • 未知发件人会收到配对码；消息在批准前被忽略（配对码在 1 小时后过期）。
  • 批准方式：
    • openclaw pairing list bluebubbles
    • openclaw pairing approve bluebubbles <CODE>
  • 配对是默认的令牌交换。详情：配对

群组（Groups）：

  • channels.bluebubbles.groupPolicy = open | allowlist | disabled（默认：allowlist）。
  • channels.bluebubbles.groupAllowFrom 控制当设置为 allowlist 时谁可以在群组中触发。

提及门控（Mention gating）（群组）

BlueBubbles 支持群组聊天的提及门控，匹配 iMessage/WhatsApp 行为：

  • 使用 agents.list[].groupChat.mentionPatterns（或 messages.groupChat.mentionPatterns）检测提及。
  • 当为群组启用 requireMention 时，代理仅在被提及时响应。
  • 来自授权发送者的控制命令绕过提及门控。

按群组配置：

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

命令门控（Command gating）

  • 控制命令（例如 /config、/model）需要授权。
  • 使用 allowFrom 和 groupAllowFrom 确定命令授权。
  • 授权发送者即使在群组中不提及也可以运行控制命令。

输入状态 + 已读回执

  • 输入指示器（Typing indicators）：在响应生成前和期间自动发送。
  • 已读回执（Read receipts）：由 channels.bluebubbles.sendReadReceipts 控制（默认：true）。
  • 输入指示器：OpenClaw 发送输入开始事件；BlueBubbles 在发送或超时时自动清除输入状态（通过 DELETE 手动停止不可靠）。
{
  channels: {
    bluebubbles: {
      sendReadReceipts: false  // 禁用已读回执
    }
  }
}

高级操作（Advanced actions）

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

{
  channels: {
    bluebubbles: {
      actions: {
        reactions: true,       // 点赞（tapbacks）（默认：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：添加/删除点赞反应（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）
    • 语音备忘录（Voice memos）：使用 MP3 或 CAF 音频设置 asVoice: true 以作为 iMessage 语音消息发送。BlueBubbles 在发送语音备忘录时将 MP3 转换为 CAF。

消息 ID（短 ID vs 完整 ID）

OpenClaw 可能会显示短消息 ID（例如 1、2）以节省令牌（tokens）。

  • MessageSid / ReplyToId 可以是短 ID。
  • MessageSidFull / ReplyToIdFull 包含提供商的完整 ID。
  • 短 ID 在内存中；它们可能在重启或缓存驱逐时过期。
  • 操作接受短 ID 或完整 messageId，但如果短 ID 不再可用会报错。

对于持久的自动化和存储，使用完整 ID：

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

参见 配置 了解模板变量。

块流式传输（Block streaming）

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

{
  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.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：启用块流式传输（默认：true）。
  • channels.bluebubbles.textChunkLimit：出站分块大小（字符）（默认：4000）。
  • channels.bluebubbles.chunkMode：length（默认）仅在超过 textChunkLimit 时分割；newline 在长度分块之前在空行（段落边界）处分割。
  • channels.bluebubbles.mediaMaxMb：入站媒体上限（MB）（默认：8）。
  • 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:123
  • chat_identifier:...
  • 直接句柄：+15555550123、[email protected]
    • 如果直接句柄没有现有的私信聊天，OpenClaw 将通过 POST /api/v1/chat/new 创建一个。这需要启用 BlueBubbles Private API。

安全

  • Webhook 请求通过比较 guid/password 查询参数或头部与 channels.bluebubbles.password 进行身份验证。来自 localhost 的请求也被接受。
  • 保密 API 密码和 webhook 端点（将它们视为凭据）。
  • Localhost 信任意味着同主机的反向代理可能会无意中绕过密码。如果你代理网关，在代理处要求身份验证并配置 gateway.trustedProxies。参见 网关安全。
  • 如果在局域网外暴露 BlueBubbles 服务器，请启用 HTTPS + 防火墙规则。

故障排除

  • 如果输入/已读事件停止工作，检查 BlueBubbles webhook 日志并验证网关路径与 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。

有关一般频道工作流程参考，请参见 频道 和 插件 指南。

← 返回文档首页