Signal-Bot

A library for creating bots that interact with the Signal application. Not affiliated with the Signal project or Open Whisper Systems. This implementation bases on the abandoned signal-bot.

Install with npm install signal-bot-node.

Currently, only tested on Linux, with Node.js >=18.0.0.

This library requires a working installation of signal-cli running in daemon mode with the phone number you want to use, or the multi-account feature enabled.

Tested on v0.13.1 of signal-cli.

Attention: this library is currently under heavy development and not ready for production use.

Example Usage

Basic Commands

1const {Client} = require("signal-bot");
2
3const bot = new Client();
4
5const prefix = "!";
6
7bot.on("message", msg => {
8  if (!msg.content.startsWith(prefix)) return;
9  const command = msg.content.slice(prefix.length);
10
11  if (command === "hello") {
12    msg.conversation.sendMessage("Hello World!");
13  } else if (command === "whoami") {
14    msg.conversation.sendMessage(`You are ${msg.author.id}`);
15  }
16});
17
18bot.connect();

Send the bot !hello and it should respond with Hello World!.

Send the bot !whoami and it should respond with You are <phone number>.

Missing Features

• signal-cli D-Bus missing features:
  • Group conversation invite event
  • Group conversation leave event
  • Reactions
  • Stickers
• Contact management
• Additional user/group member information/profiles
• Group conversation member list
• Group conversation admin functions