java-signal-connector

This spring boot library allows you to send messages via Signal messenger using the docker container signal-cli-rest-api There is an official library from signal, you could also use that without the container.

Supported API functions

• Send messages to a list of configured recipients
• Send messages to a configured admin
• Basic auth for containers e.g. behind Traefik reverse proxy

Usage

Maven setup

        <dependency>
            <groupId>eu.planlos</groupId>
            <artifactId>java-signal-connector</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>

Config class setup

@Configuration
@ComponentScan(basePackages = "eu.planlos.javasignalconnector")
public class SignalConfig {}

Properties setup

Property	Type	Description
signal.api.active	Boolean	Enable/Disable usage of API
signal.api.address	String	URL of the signal-cli-rest-api container
signal.api.user	String	Basic auth username
signal.api.password	String	Basic auth password
signal.api.phone-sender	String	Phone number of message sender (+49xxxxx)
signal.api.phone-recipients	List	Comma seperated values of phone numbers
signal.api.phone-admin	String	Phone number of admin (+49xxxxx)
signal.api.message-prefix	String	Prefix to be used for signal messages
signal.api.retry-count	Integer	Retry count in case of exception
signal.api.retry-interval	Integer	Interval for retries in case of exception

Examples

signal.api.phone-recipients=+4915000000,+4915000001,+4915000002

Use in your code

Autowire the SignalService

class YourClass {
    @Autowired
    private final SignalService signalService;
}

Call service to send message and catch Exception if necessary

import eu.planlos.javasignalconnector.model.SignalException;

class YourClass {
    yourMethod() {
        try {
            signalService.sendMessageToAdmin("Hello Admin!");
            signalService.sendMessageToRecipients("Hello configured recipients!");
        } catch (SignalException e) {
            // your code
        }
    }
}