Signal-API
Signal-API
Docker app from CorneliousJD's Repository
Overview
Dockerized Signal Messenger REST API
This project creates a small dockerized REST API around signal-cli.
Useful for Apprise!
At the moment, the following functionality is exposed via REST:
Register a number
Verify the number using the code received via SMS
Send message (+ attachments) to multiple recipients (or a group)
Receive messages
Link devices
Create/List/Remove groups
List/Serve/Delete attachments
Update profile
and many more
Runtime arguments
- Web UI
http://[IP]:[PORT:8080]/v1/qrcodelink?device_name=Signal%20API- Network
bridge- Shell
bash- Privileged
- false
Template configuration
Web UIPorttcp
- Target
- 8080
- Default
- 8739
- Value
- 8739
AppDataPathrw
- Target
- /home/.local/share/signal-cli
- Default
- /mnt/cache/appdata/signal-api
- Value
- /mnt/cache/appdata/signal-api
ModeVariable
normal, native, or json-rpc, see GitHub for full detials.
- Target
- MODE
- Default
- normal
- Value
- normal
Receive ScheduleVariable
OPTIONAL Variable! WARNING Calling receive will fetch all the messages for the registered Signal number from the Signal Server! So, if you are using the REST API for receiving messages, it's not a good idea to use the AUTO_RECEIVE_SCHEDULE parameter, as you might lose some messages that way.
- Target
- AUTO_RECEIVE_SCHEDULE
- Default
- 0 22 * * *
- Value
- 0 22 * * *
Categories
Download Statistics
4,236,219
Total Downloads
162,995
This Month
133,735
Avg / Month
Total Downloads Over Time
Loading chart...
Details
Repository
bbernhard/signal-cli-rest-apiLast Updated2026-05-08
First Seen2025-02-13
Run Signal-API on Unraid.
Signal-API is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.