Signal Manager

signalmgr is a Go library designed to interact with the bbernhard/signal-cli-rest-api to manage Signal accounts more easily. This library provides a wrapper for the various signal-cli-rest-api endpoints covered in signal-cli-rest-api swagger docs.

Installation

You can install the signalmgr library using go get:

go get github.com/DonovanDiamond/signalmgr

Usage

package main

import (
	"bufio"
	"fmt"
	"log"
	"os"
	"strings"
	"time"

	"github.com/DonovanDiamond/signalmgr"
)

func main() {
	signalmgr.API_URL = "http://localhost:8080"

	scanner := bufio.NewScanner(os.Stdin)
	fmt.Print("Enter the number to register to signal: ")
	scanner.Scan()
	number := scanner.Text()

	account := signalmgr.Account{
		Number: number,
	}

	fmt.Print("Enter 'voice' if you want to use a phone call for verification (note this will take longer than SMS verification): ")
	scanner.Scan()
	voice := strings.ToLower(scanner.Text())

	fmt.Println("Go to https://signalcaptchas.org/registration/generate.html, complete the captcha, open the development console and find the line that looks like: 'Prevented navigation to “signalcaptcha://{captcha value}” due to an unknown protocol.' and copy the entire captcha value.")
	fmt.Print("Enter the captcha value including “signalcaptcha://”: ")
	scanner.Scan()
	captcha := scanner.Text()

	if voice == "voice" {
		err := account.PostRegister(captcha, false)
		if err != nil {
			log.Fatal(err)
		}
		fmt.Println("Waiting 61 seconds before requesting voice call...")
		time.Sleep(time.Second * 61)

		fmt.Println("Go to https://signalcaptchas.org/registration/generate.html and complete a new captcha like before.")
		fmt.Print("Enter the captcha value including “signalcaptcha://”: ")
		scanner.Scan()
		captcha := scanner.Text()
	
		err = account.PostRegister(captcha, true)
		if err != nil {
			log.Fatal(err)
		}
	} else {
		err := account.PostRegister(captcha, voice == "voice")
		if err != nil {
			log.Fatal(err)
		}
	}

	fmt.Print("Please enter the token sent via SMS/call to the number provided:")
	scanner.Scan()
	token := scanner.Text()
	fmt.Print("Please enter the PIN for signal (if you have one) or leave this blank:")
	scanner.Scan()
	pin := scanner.Text()

	err := account.PostRegisterVerify(token, pin)
	if err != nil {
		log.Fatal(err)
	}

	log.Println("Successfully registered!")

	fmt.Print("Enter a number to send a test message to (formatted +123456789):")
	scanner.Scan()
	numberTo := scanner.Text()
	fmt.Print("Enter a message to send:")
	scanner.Scan()
	message := scanner.Text()

	if _, err := signalmgr.PostSend(signalmgr.SendMessageV2{
		Number:     account.Number,
		Recipients: []string{numberTo},
		Message:    message,
	}); err != nil {
		log.Fatal(err)
	}

	fmt.Print("Send a message to this number and press enter to receive it:")
	scanner.Scan()

	messages, err := account.GetMessages()
	if err != nil {
		log.Fatal(err)
	}

	for _, m := range messages {
		fmt.Printf(" - %s: %s\n", m.Envelope.SourceNumber, m.Envelope.DataMessage.Message)
	}
}

Methods

Each method is based on the methods in signal-cli-rest-api swagger docs, below is a summary of them:

Account Management

• GetAccounts(): Lists all Signal accounts linked to the service.
• PostRegister(captcha string, useVoice bool): Register a phone number with the Signal network.
• PostRegisterVerify(token string, pin string): Verify a registered phone number.
• PostUnregistert(data struct{ DeleteAccount bool; DeleteLocalData bool }): Unregister a phone number and optionally delete its data.
• PostUsername(data struct{ Username string }): Set a username for the account.

Messaging

• GetMessages(): Receive Signal Messages, when bbernhard/signal-cli-rest-api is running in normal or native mode.
• GetMessagesSocket(messages chan<- MessageResponse): Opens a socket to receive Signal Messages and sends them to the messages channel, when bbernhard/signal-cli-rest-api is running in json-rpc mode.
• PostSend(data SendMessageV2): Send a message (supports text, mentions, attachments, etc.).
• PostReaction(data struct{ Reaction string; Recipient string; Timestamp int64 }): Send a reaction to a message.
• PostReceipt(data struct{ ReceiptType string; Recipient string; Timestamp int64 }): Send a read/viewed receipt for a message.

Contacts

• GetContacts(): List all contacts for the account.
• PostContact(data struct{ Name string; Recipient string }): Add or update contact information.
• PutContactsSync(): Sync contacts across devices.

Groups

• GetGroups(): List all Signal groups associated with the account.
• PostCreateGroup(data struct{ Name string; Members []string; Permissions struct{ AddMembers string } }): Create a new group with specified members.
• PostGroupAdmins(groupID string, data struct{ Admins []string }): Add admins to a group.
• DeleteGroupAdmins(groupID string, data struct{ Admins []string }): Remove admins from a group.
• PostGroupMembers(groupID string, data struct{ Members []string }): Add members to a group.

Attachments

• GetAttachments(): List all attachments stored in the system.
• GetAttachment(id string): Serve an attachment by its ID.
• DeleteAttachment(id string): Delete an attachment by its ID.

Device Linking

• GetLinkAccountQRCode(deviceName string): Generate a QR code to link a new device.

Configuration & Health

• GetHealth(): Check the health of the Signal API.
• GetConfiguration(): Retrieve the current API configuration.
• PostConfiguration(data Configuration): Update the API configuration.

Related Projects

• signal-cli-rest-api - Signal CLI REST API that this library interacts with.
• signal-cli - A command-line interface for Signal.

Acknowledgements

Thanks to the contributors of signal-cli and signal-cli-rest-api for providing the underlying API and documentation. This project does not replace any functionality of these projects, and is just a wrapper for easy implementation in Go.