跳转到主要内容

Signal (signal-cli)

状态:外部 CLI 集成。Gateway 通过 HTTP JSON-RPC + SSE 与 signal-cli 通信。

快速设置(初学者)

  1. 为 bot 使用单独的 Signal 号码(推荐)。
  2. 安装 signal-cli(需要 Java)。
  3. 链接 bot 设备并启动守护进程:
    • signal-cli link -n "OpenClaw"
  4. 配置 OpenClaw 并启动 gateway。
最小配置:
{
  channels: {
    signal: {
      enabled: true,
      account: "+15551234567",
      cliPath: "signal-cli",
      dmPolicy: "pairing",
      allowFrom: ["+15557654321"]
    }
  }
}

它是什么

  • 通过 signal-cli 提供 Signal 频道(非嵌入式 libsignal)。
  • 确定性路由:回复始终返回到 Signal。
  • 私聊共享 agent 的主会话;群组是隔离的(agent:<agentId>:signal:group:<groupId>)。

配置写入

默认情况下,Signal 允许写入由 /config set|unset 触发的配置更新(需要 commands.config: true)。 禁用方式:
{
  channels: { signal: { configWrites: false } }
}

号码模型(重要)

  • Gateway 连接到一个 Signal 设备signal-cli 账号)。
  • 如果您在个人 Signal 账号上运行 bot,它将忽略您自己的消息(循环保护)。
  • 对于”我给 bot 发消息然后它回复”,请使用单独的 bot 号码

设置(快速路径)

  1. 安装 signal-cli(需要 Java)。
  2. 链接 bot 账号:
    • signal-cli link -n "OpenClaw" 然后在 Signal 中扫描二维码。
  3. 配置 Signal 并启动 gateway。
示例:
{
  channels: {
    signal: {
      enabled: true,
      account: "+15551234567",
      cliPath: "signal-cli",
      dmPolicy: "pairing",
      allowFrom: ["+15557654321"]
    }
  }
}
多账号支持:使用 channels.signal.accounts 配置每个账号,可选 name。参见 gateway/configuration 了解共享模式。

外部守护进程模式(httpUrl)

如果您想自己管理 signal-cli(JVM 冷启动慢、容器初始化或共享 CPU),请单独运行守护进程并将 OpenClaw 指向它:
{
  channels: {
    signal: {
      httpUrl: "http://127.0.0.1:8080",
      autoStart: false
    }
  }
}
这会跳过 OpenClaw 内部的自动生成和启动等待。对于自动生成时启动缓慢的情况,请设置 channels.signal.startupTimeoutMs

访问控制(私聊 + 群组)

私聊:
  • 默认:channels.signal.dmPolicy = "pairing"
  • 未知发送者会收到配对码;在批准之前消息将被忽略(验证码 1 小时后过期)。
  • 批准方式:
    • openclaw pairing list signal
    • openclaw pairing approve signal <CODE>
  • 配对是 Signal 私聊的默认 token 交换方式。详情:配对
  • 仅 UUID 发送者(来自 sourceUuid)在 channels.signal.allowFrom 中存储为 uuid:<id>
群组:
  • channels.signal.groupPolicy = open | allowlist | disabled
  • 当设置为 allowlist 时,channels.signal.groupAllowFrom 控制谁可以在群组中触发。

工作原理(行为)

  • signal-cli 作为守护进程运行;gateway 通过 SSE 读取事件。
  • 入站消息被规范化为共享的频道信封。
  • 回复始终路由回相同的号码或群组。

媒体 + 限制

  • 出站文本按 channels.signal.textChunkLimit 分块(默认 4000)。
  • 可选换行分块:设置 channels.signal.chunkMode="newline" 以在长度分块之前按空行(段落边界)分割。
  • 支持附件(从 signal-cli 获取 base64)。
  • 默认媒体上限:channels.signal.mediaMaxMb(默认 8)。
  • 使用 channels.signal.ignoreAttachments 跳过媒体下载。
  • 群组历史上下文使用 channels.signal.historyLimit(或 channels.signal.accounts.*.historyLimit),回退到 messages.groupChat.historyLimit。设置 0 禁用(默认 50)。

输入指示 + 已读回执

  • 输入指示:OpenClaw 通过 signal-cli sendTyping 发送输入信号,并在回复运行时刷新它们。
  • 已读回执:当 channels.signal.sendReadReceipts 为 true 时,OpenClaw 转发允许的私聊的已读回执。
  • Signal-cli 不公开群组的已读回执。

反应(message 工具)

  • 使用 message action=react 配合 channel=signal
  • 目标:发送者 E.164 或 UUID(使用配对输出中的 uuid:<id>;裸 UUID 也可以)。
  • messageId 是您要回应的消息的 Signal 时间戳。
  • 群组反应需要 targetAuthortargetAuthorUuid
示例:
message action=react channel=signal target=uuid:123e4567-e89b-12d3-a456-426614174000 messageId=1737630212345 emoji=🔥
message action=react channel=signal target=+15551234567 messageId=1737630212345 emoji=🔥 remove=true
message action=react channel=signal target=signal:group:<groupId> targetAuthor=uuid:<sender-uuid> messageId=1737630212345 emoji=✅
配置:
  • channels.signal.actions.reactions:启用/禁用反应操作(默认 true)。
  • channels.signal.reactionLeveloff | ack | minimal | extensive
    • off/ack 禁用 agent 反应(message 工具 react 会报错)。
    • minimal/extensive 启用 agent 反应并设置指导级别。
  • 每账号覆盖:channels.signal.accounts.<id>.actions.reactionschannels.signal.accounts.<id>.reactionLevel

投递目标(CLI/cron)

  • 私聊:signal:+15551234567(或纯 E.164)。
  • UUID 私聊:uuid:<id>(或裸 UUID)。
  • 群组:signal:group:<groupId>
  • 用户名:username:<name>(如果您的 Signal 账号支持)。

配置参考(Signal)

完整配置:配置 提供商选项:
  • channels.signal.enabled:启用/禁用频道启动。
  • channels.signal.account:bot 账号的 E.164。
  • channels.signal.cliPathsignal-cli 的路径。
  • channels.signal.httpUrl:完整守护进程 URL(覆盖 host/port)。
  • channels.signal.httpHostchannels.signal.httpPort:守护进程绑定(默认 127.0.0.1:8080)。
  • channels.signal.autoStart:自动生成守护进程(如果未设置 httpUrl 则默认 true)。
  • channels.signal.startupTimeoutMs:启动等待超时(毫秒)(上限 120000)。
  • channels.signal.receiveModeon-start | manual
  • channels.signal.ignoreAttachments:跳过附件下载。
  • channels.signal.ignoreStories:忽略守护进程的故事。
  • channels.signal.sendReadReceipts:转发已读回执。
  • channels.signal.dmPolicypairing | allowlist | open | disabled(默认:pairing)。
  • channels.signal.allowFrom:私聊允许列表(E.164 或 uuid:<id>)。open 需要 "*"。Signal 没有用户名;使用电话/UUID id。
  • channels.signal.groupPolicyopen | allowlist | disabled(默认:allowlist)。
  • channels.signal.groupAllowFrom:群组发送者允许列表。
  • channels.signal.historyLimit:作为上下文包含的最大群组消息数(0 禁用)。
  • channels.signal.dmHistoryLimit:用户回合的私聊历史限制。每用户覆盖:channels.signal.dms["<phone_or_uuid>"].historyLimit
  • channels.signal.textChunkLimit:出站分块大小(字符)。
  • channels.signal.chunkModelength(默认)或 newline 以在长度分块之前按空行(段落边界)分割。
  • channels.signal.mediaMaxMb:入站/出站媒体上限(MB)。
相关全局选项:
  • agents.list[].groupChat.mentionPatterns(Signal 不支持原生提及)。
  • messages.groupChat.mentionPatterns(全局回退)。
  • messages.responsePrefix