mirror of https://github.com/caronc/apprise
Created Notify_wecombot (markdown)
parent
99427e5c4c
commit
9efdda9f2b
|
@ -0,0 +1,43 @@
|
||||||
|
## WeCom Bot
|
||||||
|
* **Source**: https://weixin.qq.com/
|
||||||
|
* **Icon Support**: No
|
||||||
|
* **Message Format**: Text
|
||||||
|
* **Message Limit**: 32768 Characters per message
|
||||||
|
|
||||||
|
### Account Setup
|
||||||
|
Sign up for WeChat [from here](https://weixin.qq.com/). You will be provided to create a user and password to associate with your account. This is all you need to use this through Apprise.
|
||||||
|
|
||||||
|
#### WeCom for PC
|
||||||
|
1. On WeCom for PC, find the target WeCom group for receiving alarm notifications.
|
||||||
|
1. Right-click the WeCom group. In the window that appears, click "Add Group Bot".
|
||||||
|
1. In the window that appears, click Create a Bot.
|
||||||
|
1. In the window that appears, enter a custom bot name and click Add.
|
||||||
|
1. You will be provided a Webhook URL that looks like:
|
||||||
|
- `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abcd`
|
||||||
|
|
||||||
|
#### WeCom for Web
|
||||||
|
1. On WebCom for Web, open the target WeCom group for receiving alarm notifications.
|
||||||
|
1. Click the group settings icon in the upper-right corner.
|
||||||
|
1. On the group settings page, choose Group Bots > Add a Bot.
|
||||||
|
1. On the management page for adding bots, enter a custom name for the new bot.
|
||||||
|
1. Click Add
|
||||||
|
1. You will be provided a Webhook URL that looks like:
|
||||||
|
- `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abcd`
|
||||||
|
|
||||||
|
### Syntax
|
||||||
|
Valid syntax is as follows:
|
||||||
|
* `wecombot://{botkey}`
|
||||||
|
* `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=abcd`
|
||||||
|
|
||||||
|
### Parameter Breakdown
|
||||||
|
| Variable | Required | Description
|
||||||
|
| --------------- | -------- | -----------
|
||||||
|
| key | No | Can optionally use the `?key` instead of passing the key in the `hostname` field. This has more value when defining configuration files.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
Send a WeCom Bot Notification:
|
||||||
|
```bash
|
||||||
|
# Assuming our {botkey} is abc123
|
||||||
|
apprise -vv -t "Test Message Title" -b "Test Message Body" \
|
||||||
|
"wecombot://abc123"
|
||||||
|
```
|
Loading…
Reference in New Issue