openclaw/docs/zh-CN/channels/bluebubbles.md

read_when, summary, title, x-i18n

read_when	summary	title	x-i18n
设置 BlueBubbles 渠道 排查 webhook 配对问题 在 macOS 上配置 iMessage	通过 BlueBubbles macOS 服务器使用 iMessage（REST 发送/接收、输入状态、回应、配对、高级操作）。	BlueBubbles	generated_at model provider source_hash source_path workflow 2026-03-16T06:21:08Z gpt-5.4 openai 877592bf7b9b06abdddd7567d56e756eff229d6ffa5056ef33fa3356086aa580 channels/bluebubbles.md 15

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 到达；传出回复、输入状态指示、已读回执和 tapback 都通过 REST 调用完成。
• 附件和贴纸会作为入站媒体接收（并在可能时展示给智能体）。
• 配对/allowlist 的工作方式与其他渠道相同（/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 webhook 指向你的 Gateway 网关（示例：https://your-gateway-host:3000/bluebubbles-webhook?password=<password>）。

5. 启动 Gateway 网关；它会注册 webhook 处理器并开始配对。

安全说明：

• 始终设置 webhook 密码。
• 始终要求进行 webhook 身份验证。无论 loopback/代理拓扑如何，除非 BlueBubbles webhook 请求包含与 channels.bluebubbles.password 匹配的 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

示例脚本（非交互式；不会抢占焦点）：

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 &quot;$HOME/Scripts/poke-messages.scpt&quot;</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 的自动化权限提示（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 Server 设置的 API 密码
• Webhook 路径（可选）：默认为 /bluebubbles-webhook
• 私信策略：pairing、allowlist、open 或 disabled
• 允许列表：电话号码、电子邮件或聊天目标

你也可以通过 CLI 添加 BlueBubbles：

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

访问控制（私信 + 群组）

私信：

• 默认值：channels.bluebubbles.dmPolicy = "pairing"。
• 未知发送者会收到一个配对码；在获得批准前，消息会被忽略（代码 1 小时后过期）。
• 通过以下方式批准：
  • openclaw pairing list bluebubbles
  • openclaw pairing approve bluebubbles <CODE>
• 配对是默认的令牌交换方式。详情见：配对

群组：

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

提及门控（群组）

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）需要授权。
• 使用 allowFrom 和 groupAllowFrom 来判断命令授权。
• 授权发送者即使在群组中未提及，也可以运行控制命令。

输入状态 + 已读回执

• 输入状态指示：会在生成响应之前和期间自动发送。
• 已读回执：由 channels.bluebubbles.sendReadReceipts 控制（默认：true）。
• 输入状态指示：OpenClaw 会发送输入开始事件；BlueBubbles 会在发送后或超时后自动清除输入状态（通过 DELETE 手动停止并不可靠）。

{
  channels: {
    bluebubbles: {
      sendReadReceipts: false, // 禁用已读回执
    },
  },
}

高级操作

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

{
  channels: {
    bluebubbles: {
      actions: {
        reactions: true, // tapback（默认：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：添加/移除 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）
• sendAttachment：发送媒体/文件（to、buffer、filename、asVoice）
  • 语音备忘录：将 asVoice: true 与 MP3 或 CAF 音频一起设置，即可作为 iMessage 语音消息发送。BlueBubbles 在发送语音备忘录时会将 MP3 转换为 CAF。

消息 ID（短 ID 与完整 ID）

OpenClaw 可能会显示短消息 ID（例如 1、2）以节省 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.dmPolicy：pairing | allowlist | open | disabled（默认：pairing）。
• channels.bluebubbles.allowFrom：私信 allowlist（handle、电子邮件、E.164 号码、chat_id:*、chat_guid:*）。
• channels.bluebubbles.groupPolicy：open | allowlist | disabled（默认：allowlist）。
• channels.bluebubbles.groupAllowFrom：群组发送者 allowlist。
• 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:123
• chat_identifier:...
• 直接 handle：+15555550123、user@example.com
  • 如果某个直接 handle 没有现有私信聊天，OpenClaw 会通过 POST /api/v1/chat/new 创建一个。这要求启用 BlueBubbles Private API。

安全

• 通过将查询参数或请求头中的 guid/password 与 channels.bluebubbles.password 进行比较来验证 webhook 请求。来自 localhost 的请求也会被接受。
• 请妥善保管 API 密码和 webhook 端点（将它们视为凭证）。
• 对 localhost 的信任意味着同主机上的反向代理可能会无意中绕过密码。如果你对 Gateway 网关进行了代理，请在代理层要求身份验证，并配置 gateway.trustedProxies。请参见 Gateway 网关安全。
• 如果要在局域网外暴露 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。

有关通用渠道工作流程参考，请参见 Channels 和 Plugins 指南。