狀態:外部 CLI 整合。Gateway 透過 HTTP 與Documentation Index
Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
signal-cli 通訊 — 可以是原生 daemon(JSON-RPC + SSE)或 bbernhard/signal-cli-rest-api container(REST + WebSocket)。
先決條件
- 你的伺服器已安裝 OpenClaw(以下 Linux 流程已在 Ubuntu 24 測試)。
- 下列其中之一:
- 主機上可用
signal-cli(原生模式),或 bbernhard/signal-cli-rest-apiDocker container(container 模式)。
- 主機上可用
- 可接收一次驗證簡訊的電話號碼(用於簡訊註冊路徑)。
- 註冊期間可透過瀏覽器存取 Signal captcha(
signalcaptchas.org)。
快速設定(初學者)
- 為 bot 使用獨立的 Signal 號碼(建議)。
- 安裝
signal-cli(如果使用 JVM build,需 Java)。 - 選擇一種設定路徑:
- 路徑 A(QR 連結):
signal-cli link -n "OpenClaw",然後用 Signal 掃描。 - 路徑 B(簡訊註冊): 使用 captcha + 簡訊驗證註冊專用號碼。
- 路徑 A(QR 連結):
- 設定 OpenClaw 並重新啟動 gateway。
- 傳送第一則 DM 並核准 pairing(
openclaw pairing approve signal <CODE>)。
| 欄位 | 說明 |
|---|---|
account | E.164 格式的 bot 電話號碼(+15551234567) |
cliPath | signal-cli 的路徑(若在 PATH 上則為 signal-cli) |
dmPolicy | DM 存取政策(建議 pairing) |
allowFrom | 允許傳送 DM 的電話號碼或 uuid:<id> 值 |
這是什麼
- 透過
signal-cli的 Signal channel(不是嵌入式 libsignal)。 - 確定性路由:回覆一律回到 Signal。
- DM 共用 agent 的主要 session;群組則隔離(
agent:<agentId>:signal:group:<groupId>)。
設定寫入
預設允許 Signal 寫入由/config set|unset 觸發的設定更新(需要 commands.config: true)。
停用方式:
號碼模型(重要)
- gateway 連線到一個 Signal 裝置(
signal-cli帳號)。 - 如果你在個人 Signal 帳號上執行 bot,它會忽略你自己的訊息(迴圈保護)。
- 若要「我傳訊息給 bot,然後它回覆」,請使用獨立的 bot 號碼。
設定路徑 A:連結既有 Signal 帳號(QR)
- 安裝
signal-cli(JVM 或原生 build)。 - 連結 bot 帳號:
signal-cli link -n "OpenClaw",然後在 Signal 中掃描 QR。
- 設定 Signal 並啟動 gateway。
channels.signal.accounts 搭配每帳號設定與選用的 name。共用模式請參閱 gateway/configuration。
設定路徑 B:註冊專用 bot 號碼(簡訊,Linux)
當你想使用專用 bot 號碼,而不是連結既有 Signal app 帳號時,請使用此方式。- 取得可接收簡訊的號碼(或市話可用語音驗證)。
- 使用專用 bot 號碼以避免帳號/session 衝突。
- 在 gateway 主機上安裝
signal-cli:
signal-cli-${VERSION}.tar.gz),請先安裝 JRE 25+。
請持續更新 signal-cli;上游指出,舊版本可能會因 Signal server API 變更而中斷。
- 註冊並驗證號碼:
- 開啟
https://signalcaptchas.org/registration/generate.html。 - 完成 captcha,從「Open Signal」複製
signalcaptcha://...連結目標。 - 可行時,請從與瀏覽器 session 相同的外部 IP 執行。
- 立即再次執行註冊(captcha token 很快就會過期):
- 設定 OpenClaw、重新啟動 gateway,並驗證 channel:
- Pair 你的 DM 傳送者:
- 傳送任意訊息到 bot 號碼。
- 在伺服器上核准代碼:
openclaw pairing approve signal <PAIRING_CODE>。 - 將 bot 號碼儲存為手機聯絡人,以避免「未知聯絡人」。
signal-cliREADME:https://github.com/AsamK/signal-cli- Captcha 流程:
https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha - 連結流程:
https://github.com/AsamK/signal-cli/wiki/Linking-other-devices-(Provisioning)
外部 daemon 模式(httpUrl)
如果你想自行管理signal-cli(JVM 冷啟動慢、container 初始化或共用 CPU),請另外執行 daemon,並讓 OpenClaw 指向它:
channels.signal.startupTimeoutMs。
Container 模式(bbernhard/signal-cli-rest-api)
除了原生執行signal-cli,你也可以使用 bbernhard/signal-cli-rest-api Docker container。這會將 signal-cli 包裝在 REST API 和 WebSocket 介面後方。
需求:
- container 必須以
MODE=json-rpc執行,才能即時接收訊息。 - 在連接 OpenClaw 前,請先在 container 內註冊或連結你的 Signal 帳號。
docker-compose.yml service 範例:
apiMode 欄位控制 OpenClaw 使用哪一種 protocol:
| 值 | 行為 |
|---|---|
"auto" | (預設)探測兩種 transport;streaming 會驗證 container WebSocket 接收 |
"native" | 強制使用原生 signal-cli(/api/v1/rpc 的 JSON-RPC,/api/v1/events 的 SSE) |
"container" | 強制使用 bbernhard container(/v2/send 的 REST,/v1/receive/{account} 的 WebSocket) |
apiMode 為 "auto" 時,OpenClaw 會快取偵測到的模式 30 秒,以避免重複探測。Container receive 只有在 /v1/receive/{account} 升級為 WebSocket 後才會被選為 streaming,這需要 MODE=json-rpc。
Container 模式支援與原生模式相同的 Signal channel 操作,只要 container 暴露對應 API:傳送、接收、attachments、typing indicators、已讀/已檢視 receipts、reactions、群組與 styled text。OpenClaw 會將其原生 Signal RPC 呼叫轉換為 container 的 REST payload,包括 group.{base64(internal_id)} group ID,以及用於格式化文字的 text_mode: "styled"。
操作注意事項:
- Container 模式請使用
autoStart: false。選擇apiMode: "container"時,OpenClaw 不應產生原生 daemon。 - 接收請使用
MODE=json-rpc。MODE=normal可能讓/v1/about看起來健康,但/v1/receive/{account}不會 WebSocket-upgrade,因此 OpenClaw 在auto模式下不會選擇 container receive streaming。 - 當你知道
httpUrl指向 bbernhard 的 REST API 時,設定apiMode: "container"。當你知道它指向原生signal-cliJSON-RPC/SSE 時,設定apiMode: "native"。部署可能不同時使用"auto"。 - Container attachment 下載會遵守與原生模式相同的媒體位元組限制。當伺服器傳送
Content-Length時,過大的回應會在完整緩衝前遭拒;否則會在 streaming 時拒絕。
存取控制(DM + 群組)
DM:- 預設:
channels.signal.dmPolicy = "pairing"。 - 未知傳送者會收到 pairing code;在核准前訊息會被忽略(代碼 1 小時後過期)。
- 透過以下方式核准:
openclaw pairing list signalopenclaw pairing approve signal <CODE>
- Pairing 是 Signal DM 預設的 token 交換方式。詳細資訊:Pairing
- 僅 UUID 的傳送者(來自
sourceUuid)會在channels.signal.allowFrom中儲存為uuid:<id>。
channels.signal.groupPolicy = open | allowlist | disabled。- 設定
allowlist時,channels.signal.groupAllowFrom控制哪些群組或傳送者可以觸發群組回覆;項目可以是 Signal group ID(raw、group:<id>或signal:group:<id>)、傳送者電話號碼、uuid:<id>值,或*。 channels.signal.groups["<group-id>" | "*"]可使用requireMention、tools和toolsBySender覆寫群組行為。- 多帳號設定中,使用
channels.signal.accounts.<id>.groups進行每帳號覆寫。 - 透過
groupAllowFromallowlist 某個 Signal 群組,本身不會停用 mention gating。除非設定requireMention=true,否則特別設定的channels.signal.groups["<group-id>"]項目會處理每則群組訊息。 - 執行階段注意事項:如果完全缺少
channels.signal,執行階段會在群組檢查時 fallback 至groupPolicy="allowlist"(即使已設定channels.defaults.groupPolicy)。
運作方式(行為)
- 原生模式:
signal-cli以 daemon 形式執行;gateway 透過 SSE 讀取 events。 - Container 模式:gateway 透過 REST API 傳送,並透過 WebSocket 接收。
- 傳入訊息會正規化為共用 channel envelope。
- 回覆一律路由回相同號碼或群組。
媒體 + 限制
- 傳出文字會依
channels.signal.textChunkLimit分段(預設 4000)。 - 選用的換行分段:設定
channels.signal.chunkMode="newline",先依空白行(段落邊界)分割,再依長度分段。 - 支援 attachments(從
signal-cli擷取 base64)。 - 當
contentType缺失時,語音筆記 attachment 會使用signal-cli檔名作為 MIME fallback,因此音訊轉錄仍可分類 AAC 語音備忘錄。 - 預設媒體上限:
channels.signal.mediaMaxMb(預設 8)。 - 使用
channels.signal.ignoreAttachments跳過下載媒體。 - 群組歷史 context 使用
channels.signal.historyLimit(或channels.signal.accounts.*.historyLimit),並 fallback 至messages.groupChat.historyLimit。設定為0可停用(預設 50)。
Typing + 已讀 receipts
- Typing indicators:OpenClaw 透過
signal-cli sendTyping傳送 typing signals,並在回覆執行期間持續刷新。 - 已讀 receipts:當
channels.signal.sendReadReceipts為 true 時,OpenClaw 會為允許的 DM 轉送已讀 receipts。 - Signal-cli 不會暴露群組的已讀 receipts。
Reactions(message tool)
- 使用
message action=react搭配channel=signal。 - 目標:寄件者 E.164 或 UUID(使用配對輸出的
uuid:<id>;裸 UUID 也可使用)。 messageId是你要回應的訊息的 Signal 時間戳記。- 群組回應需要
targetAuthor或targetAuthorUuid。
channels.signal.actions.reactions:啟用/停用回應動作(預設為 true)。channels.signal.reactionLevel:off | ack | minimal | extensive。off/ack會停用代理程式回應(訊息工具react會出錯)。minimal/extensive會啟用代理程式回應並設定指引層級。
- 個別帳號覆寫:
channels.signal.accounts.<id>.actions.reactions、channels.signal.accounts.<id>.reactionLevel。
傳遞目標(CLI/cron)
- DM:
signal:+15551234567(或純 E.164)。 - UUID DM:
uuid:<id>(或裸 UUID)。 - 群組:
signal:group:<groupId>。 - 使用者名稱:
username:<name>(如果你的 Signal 帳號支援)。
疑難排解
先執行這個階梯:- Daemon 可連線但沒有回覆:確認帳號/daemon 設定(
httpUrl、account)與接收模式。 - DM 被忽略:寄件者正在等待配對核准。
- 群組訊息被忽略:群組寄件者/提及閘控阻擋了傳遞。
- 編輯後出現設定驗證錯誤:執行
openclaw doctor --fix。 - 診斷中缺少 Signal:確認
channels.signal.enabled: true。
安全性注意事項
signal-cli會在本機儲存帳號金鑰(通常位於~/.local/share/signal-cli/data/)。- 伺服器遷移或重建前,請備份 Signal 帳號狀態。
- 除非你明確想要更廣泛的 DM 存取權,否則請保留
channels.signal.dmPolicy: "pairing"。 - SMS 驗證只在註冊或復原流程中需要,但失去號碼/帳號的控制權可能會讓重新註冊變得複雜。
設定參考(Signal)
完整設定:設定 提供者選項:channels.signal.enabled:啟用/停用頻道啟動。channels.signal.apiMode:auto | native | container(預設:auto)。請參閱容器模式。channels.signal.account:機器人帳號的 E.164。channels.signal.cliPath:signal-cli的路徑。channels.signal.httpUrl:完整 daemon URL(覆寫主機/連接埠)。channels.signal.httpHost、channels.signal.httpPort:daemon 綁定(預設 127.0.0.1:8080)。channels.signal.autoStart:自動產生 daemon(如果未設定httpUrl,預設為 true)。channels.signal.startupTimeoutMs:啟動等待逾時,單位為 ms(上限 120000)。channels.signal.receiveMode:on-start | manual。channels.signal.ignoreAttachments:略過附件下載。channels.signal.ignoreStories:忽略來自 daemon 的限時動態。channels.signal.sendReadReceipts:轉送已讀回條。channels.signal.dmPolicy:pairing | allowlist | open | disabled(預設:pairing)。channels.signal.allowFrom:DM 允許清單(E.164 或uuid:<id>)。open需要"*"。Signal 沒有使用者名稱;請使用電話/UUID ID。channels.signal.groupPolicy:open | allowlist | disabled(預設:allowlist)。channels.signal.groupAllowFrom:群組允許清單;接受 Signal 群組 ID(原始值、group:<id>或signal:group:<id>)、寄件者 E.164 號碼,或uuid:<id>值。channels.signal.groups:依 Signal 群組 ID(或"*")作為鍵的個別群組覆寫。支援欄位:requireMention、tools、toolsBySender。channels.signal.accounts.<id>.groups:多帳號設定中channels.signal.groups的個別帳號版本。channels.signal.historyLimit:要作為脈絡納入的群組訊息上限(0 會停用)。channels.signal.dmHistoryLimit:以使用者回合計算的 DM 歷史記錄限制。個別使用者覆寫: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。