Skip to content

Latest commit

 

History

History
179 lines (153 loc) · 7.41 KB

File metadata and controls

179 lines (153 loc) · 7.41 KB
summary 通过 signal-cli (JSON-RPC + SSE) 的 Signal 支持、设置和号码模式
read_when
设置 Signal 支持
调试 Signal 发送/接收

Signal (signal-cli)

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

快速设置(初学者)

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

最小配置:

{
  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 账户上运行 bot,它将忽略您自己的消息(循环保护)。
  • 对于"我给 bot 发短信,它回复",使用单独的 bot 号码

设置(快速路径)

  1. 安装 signal-cli(需要 Java)。
  2. 链接 bot 账户:
    • signal-cli link -n "Moltbot" 然后在 Signal 中扫描 QR。
  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),单独运行守护进程并将 Moltbot 指向它:

{
  channels: {
    signal: {
      httpUrl: "http://127.0.0.1:8080",
      autoStart: false
    }
  }
}

这跳过 Moltbot 中的自动生成和启动等待。对于自动生成时的缓慢启动,设置 channels.signal.startupTimeoutMs

访问控制(私信 + 群组)

私信:

  • 默认: channels.signal.dmPolicy = "pairing"
  • 未知发送者会收到配对代码;消息将被忽略,直到被批准(代码在 1 小时后过期)。
  • 通过以下方式批准:
    • moltbot pairing list signal
    • moltbot pairing approve signal <CODE>
  • 配对是 Signal 私信的默认令牌交换。详情: 配对
  • 仅 UUID 的发送者(来自 sourceUuid)存储为 channels.signal.allowFrom 中的 uuid:<id>

群组:

  • 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)。

输入 + 已读回执

  • 输入指示器: Moltbot 通过 signal-cli sendTyping 发送输入信号,并在回复运行时刷新它们。
  • 已读回执:channels.signal.sendReadReceipts 为 true 时,Moltbot 为允许的私信转发已读回执。
  • 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.reactionLevel: off | 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: bot 账户的 E.164。
  • channels.signal.cliPath: signal-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.receiveMode: on-start | manual
  • channels.signal.ignoreAttachments: 跳过附件下载。
  • channels.signal.ignoreStories: 忽略来自守护进程的动态。
  • channels.signal.sendReadReceipts: 转发已读回执。
  • channels.signal.dmPolicy: pairing | allowlist | open | disabled(默认: pairing)。
  • channels.signal.allowFrom: 私信允许列表(E.164 或 uuid:<id>)。open 需要 "*"。Signal 没有用户名;使用电话/UUID ID。
  • channels.signal.groupPolicy: open | 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.chunkMode: length(默认)或 newline 在长度分块之前按空行(段落边界)分割。
  • channels.signal.mediaMaxMb: 入站/出站媒体上限(MB)。

相关全局选项:

  • agents.list[].groupChat.mentionPatterns(Signal 不支持原生提及)。
  • messages.groupChat.mentionPatterns(全局回退)。
  • messages.responsePrefix