Signal support via signal-cli (JSON-RPC + SSE), setup, and number model

Read when…
  • Setting up Signal support
  • Debugging Signal send/receive

Signal (signal-cli)

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

快速设置(初学者)

  1. 为机器人使用一个单独的Signal号码(推荐)。
  2. 安装signal-cli(需要Java)。
  3. 链接机器人设备并启动守护进程:
    • signal-cli link -n "OpenClaw"
  4. 配置OpenClaw并启动网关。

最小配置:

{
  channels: {
    signal: {
      enabled: true,
      account: "+15551234567",
      cliPath: "signal-cli",
      dmPolicy: "pairing",
      allowFrom: ["+15557654321"],
    },
  },
}

什么是它

  • 通过signal-cli的Signal通道(不是嵌入的libsignal)。
  • 确定性路由:回复总是回到Signal。
  • 私信共享代理的主要会话;群组是隔离的(agent:<agentId>:signal:group:<groupId>)。

配置写入

默认情况下,允许Signal写入由/config set|unset触发的配置更新(需要commands.config: true)。

禁用:

{
  channels: { signal: { configWrites: false } },
}

号码模型(重要)

  • 网关连接到一个Signal设备(即signal-cli账户)。
  • 如果你在你的个人Signal账户上运行机器人,它会忽略你自己的消息(循环保护)。
  • 对于“我发消息给机器人,它回复”,使用一个单独的机器人号码

设置(快速路径)

  1. 安装signal-cli(需要Java)。
  2. 链接一个机器人账户:
    • signal-cli link -n "OpenClaw"然后在Signal中扫描二维码。
  3. 配置Signal并启动网关。

示例:

{
  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私信的默认令牌交换方式。详情:配对
  • 仅UUID发送者(来自sourceUuid)存储为uuid:<id>channels.signal.allowFrom中。

群组:

  • channels.signal.groupPolicy = open | allowlist | disabled
  • channels.signal.groupAllowFrom控制谁可以在群组中触发,当allowlist被设置时。

工作原理(行为)

  • signal-cli作为守护进程运行;网关通过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为真时,OpenClaw转发允许的私信的已读回执。
  • Signal-cli不暴露群组的已读回执。

反应(消息工具)

  • 使用message action=reactchannel=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禁用代理反应(消息工具react将出错)。
    • minimal/extensive启用代理反应并设置指导级别。
  • 按账户覆盖: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:机器人的E.164号码。
  • channels.signal.cliPathsignal-cli的路径。
  • channels.signal.httpUrl:完整的守护进程URL(覆盖主机/端口)。
  • 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(默认:配对)。
  • channels.signal.allowFrom:私信白名单(E.164或uuid:<id>)。open需要"*"。Signal没有用户名;使用电话/UUID ID。
  • channels.signal.groupPolicyopen | allowlist | disabled(默认:白名单)。
  • 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