mirror of
https://github.com/kha7iq/pingme.git
synced 2025-05-15 14:20:18 -07:00
docs: add docs for service wechat official account
This commit is contained in:
parent
ee6f51722e
commit
b20d74f335
@ -14,6 +14,7 @@ possible.
|
|||||||
- `service/telegram` - Telegram notification service.
|
- `service/telegram` - Telegram notification service.
|
||||||
- `service/pushover` - Pushover Notification service.
|
- `service/pushover` - Pushover Notification service.
|
||||||
- `service/line` - Line notification service.
|
- `service/line` - Line notification service.
|
||||||
|
- `service/wechat` - Wechat Official Account notification service.
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
|
@ -59,6 +59,7 @@ platforms.
|
|||||||
- *Telegram*
|
- *Telegram*
|
||||||
- *Twillio*
|
- *Twillio*
|
||||||
- *Line Messenger*
|
- *Line Messenger*
|
||||||
|
- *Wechat Official Account*
|
||||||
|
|
||||||
## Demo
|
## Demo
|
||||||
|
|
||||||
|
@ -643,3 +643,58 @@ pingme email \
|
|||||||
| EMAIL_PORT | "587" |
|
| EMAIL_PORT | "587" |
|
||||||
| EMAIL_MESSAGE | "" |
|
| EMAIL_MESSAGE | "" |
|
||||||
| EMAIL_SUBJECT | "" |
|
| EMAIL_SUBJECT | "" |
|
||||||
|
|
||||||
|
|
||||||
|
## Wechat Official Account
|
||||||
|
|
||||||
|
Wechat uses appid, appsecret, chatbot server token and encoding AES key for authentication, and sends messages.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pingme wechat
|
||||||
|
--appid "xxxxxxxx" \
|
||||||
|
--appsecret 'xxxxxxxxxx' \
|
||||||
|
--token 'xxxxxxxxxx' \
|
||||||
|
--aes 'IGNORED-IN-SANDBOX' \
|
||||||
|
--msg 'content of message' \
|
||||||
|
--receivers 'some receivers'
|
||||||
|
```
|
||||||
|
|
||||||
|
- GitHub Action
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on: [push]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
pingme-job:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
name: PingMe
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Ping me On
|
||||||
|
uses: kha7iq/pingme-action@v1
|
||||||
|
env:
|
||||||
|
WECHAT_APPID: ${{ secrets.WECHAT_APPID }}
|
||||||
|
WECHAT_APPSECRET: ${{ secrets.WECHAT_APPSECRET }}
|
||||||
|
WECHAT_TOKEN: ${{ secrets.WECHAT_TOKEN }}
|
||||||
|
WECHAT_ENCODINGAESKEY: ${{ secrets.WECHAT_ENCODINGAESKEY }}
|
||||||
|
WECHAT_RECEIVER_IDS: ${{ secrets.WECHAT_RECEIVER_IDS }}
|
||||||
|
WECHAT_MSG_TITLE: 'Reference: ${{ github.ref }}'
|
||||||
|
WECHAT_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
|
||||||
|
|
||||||
|
with:
|
||||||
|
service: wechat
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Variables**
|
||||||
|
|
||||||
|
| Variables | Default Value |
|
||||||
|
| -------------------------- | :----------------: |
|
||||||
|
| WECHAT_APPID | "" |
|
||||||
|
| WECHAT_APPSECRET | "" |
|
||||||
|
| WECHAT_TOKEN | "" |
|
||||||
|
| WECHAT_ENCODINGAESKEY | "" |
|
||||||
|
| WECHAT_RECEIVER_IDS | "" |
|
||||||
|
| WECHAT_MSG_TITLE | "" |
|
||||||
|
| WECHAT_MESSAGE | "" |
|
||||||
|
Loading…
x
Reference in New Issue
Block a user