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

Created Notify_signal (markdown)

master
Chris Caron 2022-04-18 13:30:10 -04:00
parent 2e95edbd40
commit 91cb79e1d3
1 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
Notify_signal.md Normal file

@ -0,0 +1,48 @@
## Signal API
* **Source**: https://github.com/bbernhard/signal-cli-rest-api
* **Icon Support**: No
* **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)
The **{FromPhoneNo}** must be the number associated with your account.
### Syntax
Valid syntax is as follows:
* `signal://{user}:{password}@{hostname}/{from_phone}`
* `signal://{user}:{password}@{hostname}:{port}/{from_phone}`
* `signal://{user}:{password}@{hostname}/{from_phone}/{to_phone}`
* `signal://{user}:{password}@{hostname}:{port}/{from_phone}/{from_phone}`
You can post in multiple chats by simply chaining them at the end of the URL.
* `signal://{user}:{password}@{hostname}:{port}/{from_phone}/{to_phone1}/{to_phone2}/{to_phone3}`
* `signals://{user}:{password}@{hostname}:{port}/{from_phone}/{to_phone1}/{to_phone2}/{to_phone3}`
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
| hostname | Yes | The Web Server's hostname
| port | No | The port our Web server is listening on. By default the port is **80** for **signal://** and **443** for all **singals://** references.
| user | No | If you're system is set up to use HTTP-AUTH, you can provide _username_ for authentication to it.
| password | No | If you're system is set up to use HTTP-AUTH, you can provide _password_ for authentication to it.
| from | Yes | This must be a _From Phone Number_ you've added to the API service.
| to | **\*No** | A phone number you wish to send your notification to. If one isn't specified, then the `from` is used instead.
| batch | No | Send multiple specified notifications in a single batch (1 upstream post to the end server). By default this is set to `no`.
| status | No | Optionally include a small little ASCII string representing the notification status being sent (inline with it) by default this is set to `no`.
#### Example
Send a Signal Notification (via Signal API):
```bash
# Assuming our {Hostname} is localhost (hosting the bbernhard/signal-cli-rest-api)
# Assuming our {FromPhoneNo} is +1-900-555-9999
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
signal://localhost/19005559999/18005551223
# the following would also have worked (spaces, brackets,
# 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
```