mirror of
https://github.com/caronc/apprise.git
synced 2024-12-13 10:21:51 +01:00
Created Notify_boxcar (markdown)
parent
0744705300
commit
b40b155f9a
51
Notify_boxcar.md
Normal file
51
Notify_boxcar.md
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
## Boxcar Notifications
|
||||||
|
* **Source**: https://boxcar.io/
|
||||||
|
* **Icon Support**: No
|
||||||
|
* **Message Format**: Text
|
||||||
|
* **Message Limit**: 10000 Characters per Message
|
||||||
|
|
||||||
|
### Syntax
|
||||||
|
Valid authentication syntaxes are as follows:
|
||||||
|
* **boxcar**:://**{hostname}**
|
||||||
|
* **boxcar**:://**{hostname}**:**{port}**
|
||||||
|
* **boxcar**:://**{user}**:**{hostname}**
|
||||||
|
* **boxcar**:://**{user}**@**{password}**:**{hostname}**
|
||||||
|
|
||||||
|
Tags support:
|
||||||
|
* **boxcar**:://**{hostname}**/**@{tag_id}**
|
||||||
|
* **boxcar**:://**{hostname}**/**@{tag_id01}**/**@{tag_id02}**/**@{tag_idNN}**
|
||||||
|
Device Tokens:
|
||||||
|
* **boxcar**:://**{hostname}**/**{device_id}**
|
||||||
|
* **boxcar**:://**{hostname}**/**{device_id01}**/**{device_id02}**/**{device_idNN}**
|
||||||
|
|
||||||
|
Alias support:
|
||||||
|
* **boxcar**:://**{hostname}**/**{alias}**
|
||||||
|
* **boxcar**:://**{hostname}**/**{alias01}**/**{alias02}**/**{aliasNN}**
|
||||||
|
|
||||||
|
You can also form any combination of the above and perform updates from one url:
|
||||||
|
* **boxcar**:://**{accesstoken}**/**{tag_id}**/**{device_id}**/**@{alias_id}**
|
||||||
|
|
||||||
|
Secure connections can be made by using **boxcars://**.
|
||||||
|
|
||||||
|
### Parameter Breakdown
|
||||||
|
| Variable | Required | Description
|
||||||
|
| ----------- | -------- | -----------
|
||||||
|
| hostname | Yes | The server Boxcar is listening on.
|
||||||
|
| port | No | The port Boxcar is listening on. By default the port is **80** for **boxcar://** and **443** for all **boxcars://** references.
|
||||||
|
| user | No | If your boxcar server is protected by a user/pass combo, you will be required to provide it.
|
||||||
|
| password | No | If your boxcar server is protected by a user/pass combo, you will be required to provide it.
|
||||||
|
| device_id | No | Associated devices with your Boxcar setup. All _device_ids_ are 64 characters in length.
|
||||||
|
| tag_id | No | Tags must be prefixed with a @ symbol or they will be interpreted as a _device_id_ and/or _alias_.
|
||||||
|
| alias | No | Associated aliases with your Boxcar setup. All _alias_ids_ are 1 to 63 characters in length.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
Send a _secure_ Boxcar notification to an alias and a _tag_:
|
||||||
|
```bash
|
||||||
|
# Assume:
|
||||||
|
# - our {hostname} is localhost
|
||||||
|
# - our host is secured (we use boxcars://)
|
||||||
|
# - our {alias} is myphone
|
||||||
|
# - our {tag} is @friends
|
||||||
|
|
||||||
|
python notify.py boxcars://localhost/myphone/@friends
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user