github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_signal (markdown)

master
Chris Caron 2022-05-17 19:51:55 -04:00
parent 8f13d0fc0c
commit bc3c4659f1
1 changed files with 39 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
Notify_signal.md

@ -1,11 +1,29 @@
## Signal API
* **Source**: https://github.com/bbernhard/signal-cli-rest-api
* **Icon Support**: No
* **Attachment Support**: Yes
* **Message Format**: Text
* **Message Limit**: 32768 Characters per message
### Account Setup
This plugin assumes you have configured yourself up with the [Signal Rest API Service](https://github.com/bbernhard/signal-cli-rest-api)
First of all you need a Signal account. So it is presumed you've either got the Apple or Android version of the Signal software.
From here, the plugin assumes you have configured yourself up with the [Signal Rest API Service](https://github.com/bbernhard/signal-cli-rest-api).
A simple setup might be:
```bash
# Create a directory for our configuration to get stored into
mkdir -p $HOME/.signal-api
# Launch a Signal API instance that listens on port 9922
docker run -d --name signal-api --restart=always -p 9922:8080 \
-v $HOME/.signal-api:/home/.local/share/signal-cli \
-e 'MODE=native' -e SIGNAL_CLI_UID=$(id -u) -e SIGNAL_CLI_GID=$(id -g) \
bbernhard/signal-cli-rest-api
```
If all goes well, you should be able to point your browser to: `http://localhost:9922/v1/qrcodelink?device_name=signal-api` and from your phone app, follow the instructions to add a **Linked Device**.
The **{FromPhoneNo}** must be the number associated with your account.
### Syntax
@ -45,4 +63,23 @@ apprise -vv -t "Test Message Title" -b "Test Message Body" \
# dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \
signal://localhost/1-(900) 555-9999/1-(800) 555-1223
```
```
Based on my personal experiences, I was able to send a notification to myself by simply doing the following:
```bash
# Assuming our {Hostname} is localhost (hosting the bbernhard/signal-cli-rest-api)
# Assuming our {Port} is 9922
# Assuming our {FromPhoneNo} is +1 555 555 1234
apprise -vv -t "Test Message Title" -b "Test Message Body" \
signal://localhost:9922/15555551234
```
I could even send an attachment without a problem:
```bash
apprise -vv -t -b "test" \
signal://localhost:9922/15555551234 --attach apprise-test.gif
```
Which produced:
![image](https://user-images.githubusercontent.com/850374/168930313-05e2bfb2-48f3-4a0a-b0ef-e5c601c97703.png)