mirror of https://github.com/caronc/apprise
Created Notify_pushplus (markdown)
parent
6f5b58eb6f
commit
db896ebeb6
|
@ -0,0 +1,62 @@
|
||||||
|
## Pushplus Notifications
|
||||||
|
* **Source**: https://www.pushplus.plus/
|
||||||
|
* **Icon Support**: No
|
||||||
|
* **Message Format**: Plain Text
|
||||||
|
* **Message Limit**: ~20,000 Characters
|
||||||
|
|
||||||
|
Pushplus is a Chinese notification platform used to send alerts to WeChat or browser endpoints. It uses a token-based webhook system to deliver messages.
|
||||||
|
|
||||||
|
Once you create an account and subscribe to a channel, you will be issued a **token** used to send messages.
|
||||||
|
|
||||||
|
### Setup Instructions
|
||||||
|
|
||||||
|
1. Register or log into your account at [Pushplus](https://www.pushplus.plus/).
|
||||||
|
2. From your dashboard, copy your **Token** under the "Push" section.
|
||||||
|
3. Optionally configure the Pushplus app in WeChat for mobile delivery.
|
||||||
|
|
||||||
|
Your notification URL will look like this:
|
||||||
|
```
|
||||||
|
https://www.pushplus.plus/send?token=abc123def456ghi789jkl012mno345pq
|
||||||
|
```
|
||||||
|
|
||||||
|
### Apprise Support
|
||||||
|
|
||||||
|
Apprise supports both the full Pushplus native webhook URL and its simplified version.
|
||||||
|
|
||||||
|
### Syntax
|
||||||
|
|
||||||
|
Valid syntax is as follows:
|
||||||
|
- `https://www.pushplus.plus/send?token={token}`
|
||||||
|
- `pushplus://{token}`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Parameter Breakdown
|
||||||
|
|
||||||
|
| Variable | Required | Description |
|
||||||
|
|----------|----------|-------------|
|
||||||
|
| token | Yes | Your personal Pushplus Token from your account settings |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
#### 1. Using the simplified Apprise URL
|
||||||
|
```bash
|
||||||
|
apprise -vv -t "Title" -b "This is the body" \
|
||||||
|
pushplus://abc123def456ghi789jkl012mno345pq
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 2. Using the token as a query parameter
|
||||||
|
```bash
|
||||||
|
apprise -vv -t "Title" -b "This is the body" \
|
||||||
|
pushplus://?token=abc123def456ghi789jkl012mno345pq
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 3. Using the full native webhook URL
|
||||||
|
```bash
|
||||||
|
apprise -vv -t "Title" -b "This is the body" \
|
||||||
|
https://www.pushplus.plus/send?token=abc123def456ghi789jkl012mno345pq
|
||||||
|
```
|
||||||
|
|
||||||
|
All forms above are supported and deliver messages identically.
|
Loading…
Reference in New Issue