iMessage (imsg)

状态：外部 CLI 集成。网关生成 imsg rpc（基于 stdio 的 JSON-RPC）。

快速设置（初学者）

  1. 确保 Messages 已在此 Mac 上登录。
  2. 安装 imsg：
    • brew install steipete/tap/imsg
  3. 使用 channels.imessage.cliPath 和 channels.imessage.dbPath 配置 OpenClaw。
  4. 启动网关并批准任何 macOS 提示（Automation + Full Disk Access）。

最小配置：

{
  channels: {
    imessage: {
      enabled: true,
      cliPath: "/usr/local/bin/imsg",
      dbPath: "/Users/<you>/Library/Messages/chat.db"
    }
  }
}

它是什么

  • 在 macOS 上由 imsg 支持的 iMessage 频道。
  • 确定性路由：回复始终返回到 iMessage。
  • 私信共享代理的主会话；群组是隔离的（agent:<agentId>:imessage:group:<chat_id>）。
  • 如果多参与者线程到达时带有 is_group=false，你仍然可以使用 channels.imessage.groups 通过 chat_id 隔离它（参见下面的"类群组线程"）。

配置写入

默认情况下，iMessage 允许写入由 /config set|unset 触发的配置更新（需要 commands.config: true）。

禁用：

{
  channels: { imessage: { configWrites: false } }
}

要求

  • macOS，Messages 已登录。
  • OpenClaw + imsg 的完全磁盘访问权限（Full Disk Access）（Messages DB 访问）。
  • 发送时的自动化权限（Automation permission）。
  • channels.imessage.cliPath 可以指向任何代理 stdin/stdout 的命令（例如，通过 SSH 连接到另一台 Mac 并运行 imsg rpc 的包装脚本）。

设置（快速路径）

  1. 确保 Messages 已在此 Mac 上登录。
  2. 配置 iMessage 并启动网关。

专用机器人 macOS 用户（用于隔离身份）

如果你希望机器人从单独的 iMessage 身份发送（并保持你的个人 Messages 清洁），请使用专用的 Apple ID + 专用的 macOS 用户。

  1. 创建专用的 Apple ID（示例：[email protected]）。
    • Apple 可能需要电话号码进行验证 / 2FA。
  2. 创建 macOS 用户（示例：openclawhome）并登录。
  3. 在该 macOS 用户中打开 Messages 并使用机器人 Apple ID 登录 iMessage。
  4. 启用远程登录（Remote Login）（系统设置 → 通用 → 共享 → 远程登录）。
  5. 安装 imsg：
    • brew install steipete/tap/imsg
  6. 设置 SSH，使 ssh <bot-macos-user>@localhost true 无需密码即可工作。
  7. 将 channels.imessage.accounts.bot.cliPath 指向以机器人用户身份运行 imsg 的 SSH 包装器。

首次运行注意事项：发送/接收可能需要机器人 macOS 用户中的 GUI 批准（Automation + Full Disk Access）。如果 imsg rpc 看起来卡住或退出，请登录该用户（屏幕共享有帮助），运行一次性 imsg chats --limit 1 / imsg send ...，批准提示，然后重试。

示例包装器（chmod +x）。将 <bot-macos-user> 替换为你的实际 macOS 用户名：

#!/usr/bin/env bash
set -euo pipefail

# 首先运行一次交互式 SSH 以接受主机密钥：
#   ssh <bot-macos-user>@localhost true
exec /usr/bin/ssh -o BatchMode=yes -o ConnectTimeout=5 -T <bot-macos-user>@localhost \
  "/usr/local/bin/imsg" "$@"

示例配置：

{
  channels: {
    imessage: {
      enabled: true,
      accounts: {
        bot: {
          name: "Bot",
          enabled: true,
          cliPath: "/path/to/imsg-bot",
          dbPath: "/Users/<bot-macos-user>/Library/Messages/chat.db"
        }
      }
    }
  }
}

对于单账户设置，使用平面选项（channels.imessage.cliPath、channels.imessage.dbPath）而不是 accounts 映射。

远程/SSH 变体（可选）

如果你想在另一台 Mac 上使用 iMessage，将 channels.imessage.cliPath 设置为通过 SSH 在远程 macOS 主机上运行 imsg 的包装器。OpenClaw 只需要 stdio。

示例包装器：

#!/usr/bin/env bash
exec ssh -T gateway-host imsg "$@"

远程附件： 当 cliPath 通过 SSH 指向远程主机时，Messages 数据库中的附件路径引用远程计算机上的文件。OpenClaw 可以通过设置 channels.imessage.remoteHost 通过 SCP 自动获取这些文件：

{
  channels: {
    imessage: {
      cliPath: "~/imsg-ssh",                     // SSH 包装器到远程 Mac
      remoteHost: "user@gateway-host",           // 用于 SCP 文件传输
      includeAttachments: true
    }
  }
}

如果未设置 remoteHost，OpenClaw 会尝试通过解析包装脚本中的 SSH 命令来自动检测它。建议进行显式配置以确保可靠性。

通过 Tailscale 远程 Mac（示例）

如果网关在 Linux 主机/VM 上运行，但 iMessage 必须在 Mac 上运行，Tailscale 是最简单的桥接：网关通过 tailnet 与 Mac 通信，通过 SSH 运行 imsg，并通过 SCP 传输附件。

架构：

┌──────────────────────────────┐          SSH (imsg rpc)          ┌──────────────────────────┐
│ Gateway host (Linux/VM)      │──────────────────────────────────▶│ Mac with Messages + imsg │
│ - openclaw gateway           │          SCP (attachments)        │ - Messages 已登录        │
│ - channels.imessage.cliPath  │◀──────────────────────────────────│ - 已启用远程登录         │
└──────────────────────────────┘                                   └──────────────────────────┘
              ▲
              │ Tailscale tailnet（主机名或 100.x.y.z）
              ▼
        user@gateway-host

具体配置示例（Tailscale 主机名）：

{
  channels: {
    imessage: {
      enabled: true,
      cliPath: "~/.openclaw/scripts/imsg-ssh",
      remoteHost: "[email protected]",
      includeAttachments: true,
      dbPath: "/Users/bot/Library/Messages/chat.db"
    }
  }
}

示例包装器（~/.openclaw/scripts/imsg-ssh）：

#!/usr/bin/env bash
exec ssh -T [email protected] imsg "$@"

注意：

  • 确保 Mac 已登录 Messages，并已启用远程登录。
  • 使用 SSH 密钥，使 ssh [email protected] 无需提示即可工作。
  • remoteHost 应与 SSH 目标匹配，以便 SCP 可以获取附件。

多账户支持：使用带有每账户配置和可选 name 的 channels.imessage.accounts。参见 gateway/configuration 了解共享模式。不要提交 ~/.openclaw/openclaw.json（它通常包含 token）。

访问控制（私信 + 群组）

私信（DMs）：

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

群组（Groups）：

  • channels.imessage.groupPolicy = open | allowlist | disabled。
  • channels.imessage.groupAllowFrom 控制当设置为 allowlist 时谁可以在群组中触发。
  • 提及门控使用 agents.list[].groupChat.mentionPatterns（或 messages.groupChat.mentionPatterns），因为 iMessage 没有原生提及元数据。
  • 多代理覆盖：在 agents.list[].groupChat.mentionPatterns 上设置按代理模式。

工作原理（行为）

  • imsg 流式传输消息事件；网关将它们规范化为共享的频道信封。
  • 回复始终路由回相同的聊天 ID 或句柄。

类群组线程（is_group=false）

一些 iMessage 线程可以有多个参与者，但仍以 is_group=false 到达，具体取决于 Messages 如何存储聊天标识符。

如果你在 channels.imessage.groups 下显式配置 chat_id，OpenClaw 将该线程视为"群组"，用于：

  • 会话隔离（单独的 agent:<agentId>:imessage:group:<chat_id> 会话键）
  • 群组允许列表 / 提及门控行为

示例：

{
  channels: {
    imessage: {
      groupPolicy: "allowlist",
      groupAllowFrom: ["+15555550123"],
      groups: {
        "42": { "requireMention": false }
      }
    }
  }
}

当你想为特定线程提供隔离的个性/模型时，这很有用（参见 多代理路由）。对于文件系统隔离，请参见 沙盒。

媒体 + 限制

  • 通过 channels.imessage.includeAttachments 可选的附件摄取。
  • 通过 channels.imessage.mediaMaxMb 设置媒体上限。

限制

  • 出站文本分块为 channels.imessage.textChunkLimit（默认 4000）。
  • 可选的换行分块：设置 channels.imessage.chunkMode="newline" 以在长度分块之前在空行（段落边界）处分割。
  • 媒体上传上限为 channels.imessage.mediaMaxMb（默认 16）。

寻址 / 传递目标

优先使用 chat_id 进行稳定路由：

  • chat_id:123（首选）
  • chat_guid:...
  • chat_identifier:...
  • 直接句柄：imessage:+1555 / sms:+1555 / [email protected]

列出聊天：

imsg chats --limit 20

配置参考（iMessage）

完整配置：配置

提供商选项：

  • channels.imessage.enabled：启用/禁用频道启动。
  • channels.imessage.cliPath：imsg 的路径。
  • channels.imessage.dbPath：Messages DB 路径。
  • channels.imessage.remoteHost：当 cliPath 指向远程 Mac 时用于 SCP 附件传输的 SSH 主机（例如 user@gateway-host）。如果未设置，则从 SSH 包装器自动检测。
  • channels.imessage.service：imessage | sms | auto。
  • channels.imessage.region：SMS 区域。
  • channels.imessage.dmPolicy：pairing | allowlist | open | disabled（默认：pairing）。
  • channels.imessage.allowFrom：私信允许列表（句柄、电子邮件、E.164 号码或 chat_id:*）。open 需要 "*"。iMessage 没有用户名；使用句柄或聊天目标。
  • channels.imessage.groupPolicy：open | allowlist | disabled（默认：allowlist）。
  • channels.imessage.groupAllowFrom：群组发送者允许列表。
  • channels.imessage.historyLimit / channels.imessage.accounts.*.historyLimit：包含作为上下文的最大群组消息数量（0 禁用）。
  • channels.imessage.dmHistoryLimit：用户回合中的私信历史限制。按用户覆盖：channels.imessage.dms["<handle>"].historyLimit。
  • channels.imessage.groups：按群组默认值 + 允许列表（使用 "*" 作为全局默认值）。
  • channels.imessage.includeAttachments：将附件摄取到上下文中。
  • channels.imessage.mediaMaxMb：入站/出站媒体上限（MB）。
  • channels.imessage.textChunkLimit：出站分块大小（字符）。
  • channels.imessage.chunkMode：length（默认）或 newline，在长度分块之前在空行（段落边界）处分割。

相关全局选项：

  • agents.list[].groupChat.mentionPatterns（或 messages.groupChat.mentionPatterns）。
  • messages.responsePrefix。
← 返回文档首页