Signal (signal-cli)
Status: external CLI integration. Gateway talks tosignal-cli over HTTP JSON-RPC + SSE.
Prerequisites
- OpenClaw installed on your server (Linux flow below tested on Ubuntu 24).
signal-cliavailable on the host where the gateway runs.- A phone number that can receive one verification SMS (for SMS registration path).
- Browser access for Signal captcha (
signalcaptchas.org) during registration.
Quick setup (beginner)
- Use a separate Signal number for the bot (recommended).
- Install
signal-cli(Java required if you use the JVM build). - Choose one setup path:
- Path A (QR link):
signal-cli link -n "OpenClaw"and scan with Signal. - Path B (SMS register): register a dedicated number with captcha + SMS verification.
- Path A (QR link):
- Configure OpenClaw and restart the gateway.
- Send a first DM and approve pairing (
openclaw pairing approve signal <CODE>).
| Field | Description |
|---|---|
account | Bot phone number in E.164 format (+15551234567) |
cliPath | Path to signal-cli (signal-cli if on PATH) |
dmPolicy | DM access policy (pairing recommended) |
allowFrom | Phone numbers or uuid:<id> values allowed to DM |
What it is
- Signal channel via
signal-cli(not embedded libsignal). - Deterministic routing: replies always go back to Signal.
- DMs share the agent’s main session; groups are isolated (
agent:<agentId>:signal:group:<groupId>).
Config writes
By default, Signal is allowed to write config updates triggered by/config set|unset (requires commands.config: true).
Disable with:
The number model (important)
- The gateway connects to a Signal device (the
signal-cliaccount). - If you run the bot on your personal Signal account, it will ignore your own messages (loop protection).
- For “I text the bot and it replies,” use a separate bot number.
Setup path A: link existing Signal account (QR)
- Install
signal-cli(JVM or native build). - Link a bot account:
signal-cli link -n "OpenClaw"then scan the QR in Signal.
- Configure Signal and start the gateway.
channels.signal.accounts with per-account config and optional name. See gateway/configuration for the shared pattern.
Setup path B: register dedicated bot number (SMS, Linux)
Use this when you want a dedicated bot number instead of linking an existing Signal app account.- Get a number that can receive SMS (or voice verification for landlines).
- Use a dedicated bot number to avoid account/session conflicts.
- Install
signal-clion the gateway host:
signal-cli-${VERSION}.tar.gz), install JRE 25+ first.
Keep signal-cli updated; upstream notes that old releases can break as Signal server APIs change.
- Register and verify the number:
- Open
https://signalcaptchas.org/registration/generate.html. - Complete captcha, copy the
signalcaptcha://...link target from “Open Signal”. - Run from the same external IP as the browser session when possible.
- Run registration again immediately (captcha tokens expire quickly):
- Configure OpenClaw, restart gateway, verify channel:
- Pair your DM sender:
- Send any message to the bot number.
- Approve code on the server:
openclaw pairing approve signal <PAIRING_CODE>. - Save the bot number as a contact on your phone to avoid “Unknown contact”.
signal-cli can de-authenticate the main Signal app session for that number. Prefer a dedicated bot number, or use QR link mode if you need to keep your existing phone app setup.
Upstream references:
signal-cliREADME:https://github.com/AsamK/signal-cli- Captcha flow:
https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha - Linking flow:
https://github.com/AsamK/signal-cli/wiki/Linking-other-devices-(Provisioning)
External daemon mode (httpUrl)
If you want to managesignal-cli yourself (slow JVM cold starts, container init, or shared CPUs), run the daemon separately and point OpenClaw at it:
channels.signal.startupTimeoutMs.
Access control (DMs + groups)
DMs:- Default:
channels.signal.dmPolicy = "pairing". - Unknown senders receive a pairing code; messages are ignored until approved (codes expire after 1 hour).
- Approve via:
openclaw pairing list signalopenclaw pairing approve signal <CODE>
- Pairing is the default token exchange for Signal DMs. Details: Pairing
- UUID-only senders (from
sourceUuid) are stored asuuid:<id>inchannels.signal.allowFrom.
channels.signal.groupPolicy = open | allowlist | disabled.channels.signal.groupAllowFromcontrols who can trigger in groups whenallowlistis set.
How it works (behavior)
signal-cliruns as a daemon; the gateway reads events via SSE.- Inbound messages are normalized into the shared channel envelope.
- Replies always route back to the same number or group.
Media + limits
- Outbound text is chunked to
channels.signal.textChunkLimit(default 4000). - Optional newline chunking: set
channels.signal.chunkMode="newline"to split on blank lines (paragraph boundaries) before length chunking. - Attachments supported (base64 fetched from
signal-cli). - Default media cap:
channels.signal.mediaMaxMb(default 8). - Use
channels.signal.ignoreAttachmentsto skip downloading media. - Group history context uses
channels.signal.historyLimit(orchannels.signal.accounts.*.historyLimit), falling back tomessages.groupChat.historyLimit. Set0to disable (default 50).
Typing + read receipts
- Typing indicators: OpenClaw sends typing signals via
signal-cli sendTypingand refreshes them while a reply is running. - Read receipts: when
channels.signal.sendReadReceiptsis true, OpenClaw forwards read receipts for allowed DMs. - Signal-cli does not expose read receipts for groups.
Reactions (message tool)
- Use
message action=reactwithchannel=signal. - Targets: sender E.164 or UUID (use
uuid:<id>from pairing output; bare UUID works too). messageIdis the Signal timestamp for the message you’re reacting to.- Group reactions require
targetAuthorortargetAuthorUuid.
channels.signal.actions.reactions: enable/disable reaction actions (default true).channels.signal.reactionLevel:off | ack | minimal | extensive.off/ackdisables agent reactions (message toolreactwill error).minimal/extensiveenables agent reactions and sets the guidance level.
- Per-account overrides:
channels.signal.accounts.<id>.actions.reactions,channels.signal.accounts.<id>.reactionLevel.
Delivery targets (CLI/cron)
- DMs:
signal:+15551234567(or plain E.164). - UUID DMs:
uuid:<id>(or bare UUID). - Groups:
signal:group:<groupId>. - Usernames:
username:<name>(if supported by your Signal account).
Troubleshooting
Run this ladder first:- Daemon reachable but no replies: verify account/daemon settings (
httpUrl,account) and receive mode. - DMs ignored: sender is pending pairing approval.
- Group messages ignored: group sender/mention gating blocks delivery.
- Config validation errors after edits: run
openclaw doctor --fix. - Signal missing from diagnostics: confirm
channels.signal.enabled: true.
Security notes
signal-clistores account keys locally (typically~/.local/share/signal-cli/data/).- Back up Signal account state before server migration or rebuild.
- Keep
channels.signal.dmPolicy: "pairing"unless you explicitly want broader DM access. - SMS verification is only needed for registration or recovery flows, but losing control of the number/account can complicate re-registration.
Configuration reference (Signal)
Full configuration: Configuration Provider options:channels.signal.enabled: enable/disable channel startup.channels.signal.account: E.164 for the bot account.channels.signal.cliPath: path tosignal-cli.channels.signal.httpUrl: full daemon URL (overrides host/port).channels.signal.httpHost,channels.signal.httpPort: daemon bind (default 127.0.0.1:8080).channels.signal.autoStart: auto-spawn daemon (default true ifhttpUrlunset).channels.signal.startupTimeoutMs: startup wait timeout in ms (cap 120000).channels.signal.receiveMode:on-start | manual.channels.signal.ignoreAttachments: skip attachment downloads.channels.signal.ignoreStories: ignore stories from the daemon.channels.signal.sendReadReceipts: forward read receipts.channels.signal.dmPolicy:pairing | allowlist | open | disabled(default: pairing).channels.signal.allowFrom: DM allowlist (E.164 oruuid:<id>).openrequires"*". Signal has no usernames; use phone/UUID ids.channels.signal.groupPolicy:open | allowlist | disabled(default: allowlist).channels.signal.groupAllowFrom: group sender allowlist.channels.signal.historyLimit: max group messages to include as context (0 disables).channels.signal.dmHistoryLimit: DM history limit in user turns. Per-user overrides:channels.signal.dms["<phone_or_uuid>"].historyLimit.channels.signal.textChunkLimit: outbound chunk size (chars).channels.signal.chunkMode:length(default) ornewlineto split on blank lines (paragraph boundaries) before length chunking.channels.signal.mediaMaxMb: inbound/outbound media cap (MB).
agents.list[].groupChat.mentionPatterns(Signal does not support native mentions).messages.groupChat.mentionPatterns(global fallback).messages.responsePrefix.