Signal

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Prasyarat

• OpenClaw terinstal di server Anda (alur Linux di bawah ini diuji pada Ubuntu 24).
• Salah satu dari:
  • signal-cli tersedia di host (mode native), atau
  • kontainer Docker bbernhard/signal-cli-rest-api (mode kontainer).
• Nomor telepon yang dapat menerima satu SMS verifikasi (untuk jalur pendaftaran SMS).
• Akses browser untuk captcha Signal (signalcaptchas.org) selama pendaftaran.

​

Penyiapan cepat (pemula)

1. Gunakan nomor Signal terpisah untuk bot (direkomendasikan).
2. Instal signal-cli (Java diperlukan jika Anda menggunakan build JVM).
3. Pilih satu jalur penyiapan:
   • Jalur A (tautan QR): signal-cli link -n "OpenClaw" dan pindai dengan Signal.
   • Jalur B (daftar SMS): daftarkan nomor khusus dengan captcha + verifikasi SMS.
4. Konfigurasikan OpenClaw dan mulai ulang Gateway.
5. Kirim DM pertama dan setujui pemasangan (openclaw pairing approve signal <CODE>).

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

​

Apa ini

• Channel Signal melalui signal-cli (bukan libsignal tersemat).
• Perutean deterministik: balasan selalu kembali ke Signal.
• DM berbagi sesi utama agen; grup diisolasi (agent:<agentId>:signal:group:<groupId>).

​

Penulisan konfigurasi

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

​

Model nomor (penting)

• Gateway terhubung ke perangkat Signal (akun signal-cli).
• Jika Anda menjalankan bot pada akun Signal pribadi Anda, bot akan mengabaikan pesan Anda sendiri (perlindungan loop).
• Untuk “saya mengirim teks ke bot dan bot membalas,” gunakan nomor bot terpisah.

​

Jalur penyiapan A: tautkan akun Signal yang ada (QR)

1. Instal signal-cli (build JVM atau native).
2. Tautkan akun bot:
   • signal-cli link -n "OpenClaw" lalu pindai QR di Signal.
3. Konfigurasikan Signal dan mulai Gateway.

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

​

Jalur penyiapan B: daftarkan nomor bot khusus (SMS, Linux)

1. Dapatkan nomor yang dapat menerima SMS (atau verifikasi suara untuk telepon rumah).
   • Gunakan nomor bot khusus untuk menghindari konflik akun/sesi.
2. Instal signal-cli pada host Gateway:

VERSION=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/AsamK/signal-cli/releases/latest | sed -e 's/^.*\/v//')
curl -L -O "https://github.com/AsamK/signal-cli/releases/download/v${VERSION}/signal-cli-${VERSION}-Linux-native.tar.gz"
sudo tar xf "signal-cli-${VERSION}-Linux-native.tar.gz" -C /opt
sudo ln -sf /opt/signal-cli /usr/local/bin/
signal-cli --version

3. Daftarkan dan verifikasi nomor:

signal-cli -a +<BOT_PHONE_NUMBER> register

1. Buka https://signalcaptchas.org/registration/generate.html.
2. Selesaikan captcha, salin target tautan signalcaptcha://... dari “Open Signal”.
3. Jalankan dari IP eksternal yang sama dengan sesi browser jika memungkinkan.
4. Jalankan pendaftaran lagi segera (token captcha cepat kedaluwarsa):

signal-cli -a +<BOT_PHONE_NUMBER> register --captcha '<SIGNALCAPTCHA_URL>'
signal-cli -a +<BOT_PHONE_NUMBER> verify <VERIFICATION_CODE>

4. Konfigurasikan OpenClaw, mulai ulang Gateway, verifikasi channel:

# If you run the gateway as a user systemd service:
systemctl --user restart openclaw-gateway.service

# Then verify:
openclaw doctor
openclaw channels status --probe

5. Pasangkan pengirim DM Anda:
   • Kirim pesan apa pun ke nomor bot.
   • Setujui kode di server: openclaw pairing approve signal <PAIRING_CODE>.
   • Simpan nomor bot sebagai kontak di ponsel Anda untuk menghindari “Unknown contact”.

• README signal-cli: https://github.com/AsamK/signal-cli
• Alur captcha: https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha
• Alur penautan: https://github.com/AsamK/signal-cli/wiki/Linking-other-devices-(Provisioning)

​

Mode daemon eksternal (httpUrl)

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

​

Mode kontainer (bbernhard/signal-cli-rest-api)

• Kontainer harus berjalan dengan MODE=json-rpc untuk penerimaan pesan real-time.
• Daftarkan atau tautkan akun Signal Anda di dalam kontainer sebelum menghubungkan OpenClaw.

signal-cli:
  image: bbernhard/signal-cli-rest-api:latest
  environment:
    MODE: json-rpc
  ports:
    - "8080:8080"
  volumes:
    - signal-cli-data:/home/.local/share/signal-cli

{
  channels: {
    signal: {
      enabled: true,
      account: "+15551234567",
      httpUrl: "http://signal-cli:8080",
      autoStart: false,
      apiMode: "container", // or "auto" to detect automatically
    },
  },
}

• Gunakan autoStart: false dengan mode kontainer. OpenClaw tidak boleh memunculkan daemon native saat apiMode: "container" dipilih.
• Gunakan MODE=json-rpc untuk penerimaan. MODE=normal dapat membuat /v1/about terlihat sehat, tetapi /v1/receive/{account} tidak melakukan upgrade WebSocket, sehingga OpenClaw tidak akan memilih streaming penerimaan kontainer dalam mode auto.
• Tetapkan apiMode: "container" saat Anda tahu httpUrl mengarah ke REST API bbernhard. Tetapkan apiMode: "native" saat Anda tahu itu mengarah ke JSON-RPC/SSE signal-cli native. Gunakan "auto" saat deployment dapat bervariasi.
• Unduhan lampiran kontainer mematuhi batas byte media yang sama seperti mode native. Respons yang terlalu besar ditolak sebelum sepenuhnya di-buffer saat server mengirim Content-Length, dan saat streaming dalam kasus lainnya.

​

Kontrol akses (DM + grup)

• Default: channels.signal.dmPolicy = "pairing".
• Pengirim tidak dikenal menerima kode pemasangan; pesan diabaikan hingga disetujui (kode kedaluwarsa setelah 1 jam).
• Setujui melalui:
  • openclaw pairing list signal
  • openclaw pairing approve signal <CODE>
• Pemasangan adalah pertukaran token default untuk DM Signal. Detail: Pemasangan
• Pengirim khusus UUID (dari sourceUuid) disimpan sebagai uuid:<id> di channels.signal.allowFrom.

• channels.signal.groupPolicy = open | allowlist | disabled.
• channels.signal.groupAllowFrom mengontrol grup atau pengirim mana yang dapat memicu balasan grup saat allowlist ditetapkan; entri dapat berupa ID grup Signal (mentah, group:<id>, atau signal:group:<id>), nomor telepon pengirim, nilai uuid:<id>, atau *.
• channels.signal.groups["<group-id>" | "*"] dapat menimpa perilaku grup dengan requireMention, tools, dan toolsBySender.
• Gunakan channels.signal.accounts.<id>.groups untuk override per akun dalam penyiapan multi-akun.
• Mengizinkan grup Signal melalui groupAllowFrom tidak menonaktifkan gating mention dengan sendirinya. Entri channels.signal.groups["<group-id>"] yang dikonfigurasi secara spesifik memproses setiap pesan grup kecuali requireMention=true ditetapkan.
• Catatan runtime: jika channels.signal sepenuhnya tidak ada, runtime melakukan fallback ke groupPolicy="allowlist" untuk pemeriksaan grup (meskipun channels.defaults.groupPolicy ditetapkan).

​

Cara kerjanya (perilaku)

• Mode native: signal-cli berjalan sebagai daemon; Gateway membaca event melalui SSE.
• Mode kontainer: Gateway mengirim melalui REST API dan menerima melalui WebSocket.
• Pesan masuk dinormalisasi ke dalam envelope channel bersama.
• Balasan selalu dirutekan kembali ke nomor atau grup yang sama.

​

Media + batas

• Teks keluar dipecah menjadi potongan sesuai channels.signal.textChunkLimit (default 4000).
• Pemotongan baris baru opsional: tetapkan channels.signal.chunkMode="newline" untuk memisahkan pada baris kosong (batas paragraf) sebelum pemotongan berdasarkan panjang.
• Lampiran didukung (base64 diambil dari signal-cli).
• Lampiran catatan suara menggunakan nama file signal-cli sebagai fallback MIME saat contentType tidak ada, sehingga transkripsi audio tetap dapat mengklasifikasikan memo suara AAC.
• Batas media default: channels.signal.mediaMaxMb (default 8).
• Gunakan channels.signal.ignoreAttachments untuk melewati pengunduhan media.
• Konteks riwayat grup menggunakan channels.signal.historyLimit (atau channels.signal.accounts.*.historyLimit), dengan fallback ke messages.groupChat.historyLimit. Tetapkan 0 untuk menonaktifkan (default 50).

​

Mengetik + tanda terima baca

• Indikator mengetik: OpenClaw mengirim sinyal mengetik melalui signal-cli sendTyping dan memperbaruinya saat balasan sedang berjalan.
• Tanda terima baca: saat channels.signal.sendReadReceipts bernilai true, OpenClaw meneruskan tanda terima baca untuk DM yang diizinkan.
• Signal-cli tidak mengekspos tanda terima baca untuk grup.

​

Reaksi (alat pesan)

• Gunakan message action=react dengan channel=signal.
• Target: E.164 pengirim atau UUID (gunakan uuid:<id> dari output pemasangan; UUID biasa juga berfungsi).
• messageId adalah timestamp Signal untuk pesan yang Anda beri reaksi.
• Reaksi grup memerlukan targetAuthor atau targetAuthorUuid.

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: aktifkan/nonaktifkan tindakan reaksi (default true).
• channels.signal.reactionLevel: off | ack | minimal | extensive.
  • off/ack menonaktifkan reaksi agen (alat pesan react akan mengalami galat).
  • minimal/extensive mengaktifkan reaksi agen dan mengatur tingkat panduan.
• Override per akun: channels.signal.accounts.<id>.actions.reactions, channels.signal.accounts.<id>.reactionLevel.

​

Target pengiriman (CLI/cron)

• DM: signal:+15551234567 (atau E.164 biasa).
• DM UUID: uuid:<id> (atau UUID biasa).
• Grup: signal:group:<groupId>.
• Nama pengguna: username:<name> (jika didukung oleh akun Signal Anda).

​

Pemecahan masalah

openclaw status
openclaw gateway status
openclaw logs --follow
openclaw doctor
openclaw channels status --probe

openclaw pairing list signal

• Daemon dapat dijangkau tetapi tidak ada balasan: verifikasi pengaturan akun/daemon (httpUrl, account) dan mode penerimaan.
• DM diabaikan: pengirim sedang menunggu persetujuan pemasangan.
• Pesan grup diabaikan: gating pengirim/mention grup memblokir pengiriman.
• Galat validasi konfigurasi setelah pengeditan: jalankan openclaw doctor --fix.
• Signal hilang dari diagnostik: konfirmasi channels.signal.enabled: true.

openclaw pairing list signal
pgrep -af signal-cli
grep -i "signal" "/tmp/openclaw/openclaw-$(date +%Y-%m-%d).log" | tail -20

​

Catatan keamanan

• signal-cli menyimpan kunci akun secara lokal (biasanya ~/.local/share/signal-cli/data/).
• Cadangkan status akun Signal sebelum migrasi atau rebuild server.
• Pertahankan channels.signal.dmPolicy: "pairing" kecuali Anda secara eksplisit menginginkan akses DM yang lebih luas.
• Verifikasi SMS hanya diperlukan untuk alur pendaftaran atau pemulihan, tetapi kehilangan kendali atas nomor/akun dapat mempersulit pendaftaran ulang.

​

Referensi konfigurasi (Signal)

• channels.signal.enabled: aktifkan/nonaktifkan startup kanal.
• channels.signal.apiMode: auto | native | container (default: auto). Lihat Mode container.
• channels.signal.account: E.164 untuk akun bot.
• channels.signal.cliPath: path ke signal-cli.
• channels.signal.httpUrl: URL daemon lengkap (mengganti host/port).
• channels.signal.httpHost, channels.signal.httpPort: bind daemon (default 127.0.0.1:8080).
• channels.signal.autoStart: spawn daemon otomatis (default true jika httpUrl tidak ditetapkan).
• channels.signal.startupTimeoutMs: batas waktu tunggu startup dalam ms (batas 120000).
• channels.signal.receiveMode: on-start | manual.
• channels.signal.ignoreAttachments: lewati unduhan lampiran.
• channels.signal.ignoreStories: abaikan cerita dari daemon.
• channels.signal.sendReadReceipts: teruskan tanda terima baca.
• channels.signal.dmPolicy: pairing | allowlist | open | disabled (default: pairing).
• channels.signal.allowFrom: allowlist DM (E.164 atau uuid:<id>). open memerlukan "*". Signal tidak memiliki nama pengguna; gunakan ID ponsel/UUID.
• channels.signal.groupPolicy: open | allowlist | disabled (default: allowlist).
• channels.signal.groupAllowFrom: allowlist grup; menerima ID grup Signal (mentah, group:<id>, atau signal:group:<id>), nomor E.164 pengirim, atau nilai uuid:<id>.
• channels.signal.groups: override per grup yang dikunci berdasarkan ID grup Signal (atau "*"). Bidang yang didukung: requireMention, tools, toolsBySender.
• channels.signal.accounts.<id>.groups: versi per akun dari channels.signal.groups untuk penyiapan multi-akun.
• channels.signal.historyLimit: pesan grup maksimum yang disertakan sebagai konteks (0 menonaktifkan).
• channels.signal.dmHistoryLimit: batas riwayat DM dalam giliran pengguna. Override per pengguna: channels.signal.dms["<phone_or_uuid>"].historyLimit.
• channels.signal.textChunkLimit: ukuran potongan keluar (karakter).
• channels.signal.chunkMode: length (default) atau newline untuk memisahkan pada baris kosong (batas paragraf) sebelum pemotongan berdasarkan panjang.
• channels.signal.mediaMaxMb: batas media masuk/keluar (MB).

• agents.list[].groupChat.mentionPatterns (Signal tidak mendukung mention native).
• messages.groupChat.mentionPatterns (fallback global).
• messages.responsePrefix.

​

Terkait

• Ringkasan Kanal — semua kanal yang didukung
• Pemasangan — autentikasi DM dan alur pemasangan
• Grup — perilaku obrolan grup dan gating mention
• Perutean Kanal — perutean sesi untuk pesan
• Keamanan — model akses dan hardening