1
0
mirror of https://github.com/kha7iq/pingme.git synced 2025-05-16 06:40:12 -07:00

docs: add documentation for twillio

This commit is contained in:
kha7iq 2021-05-03 02:07:41 +08:00
parent 42d6457057
commit f6e4829524

View File

@ -382,6 +382,52 @@ jobs:
| PUSHBULLET_TITLE | "" | | PUSHBULLET_TITLE | "" |
## Twillio SMS
SMS can be sent via twillio to multiple numbers, you can add multiple receivers separated by a comma.
```bash
pingme twillio --token 'tokenabc' --account 'sid123' --sender '+140001442' --receiver '+140001442'' --msg 'some message'
```
- 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:
TWILLIO_TOKEN: ${{ secrets.TWILLIO_TOKEN }}
TWILLIO_ACCOUNT_SID: ${{ secrets.TWILLIO_ACCOUNT_SID }}
TWILLIO_SENDER: ${{ secrets.TWILLIO_SENDER }}
TWILLIO_RECEIVER: ${{ secrets.TWILLIO_RECEIVER }}
TWILLIO_TITLE: 'Reference: ${{ github.ref }}'
TWILLIO_MESSAGE: 'Event is triggered by ${{ github.event_name }}'
with:
# Chose the messaging platform.
# slack / telegram / rocketchat / teams / pushover / discord / email / mattermost / twillio
service: twillio
```
- **Variables**
| Variables | Default Value |
| -------------------------- | :----------------: |
| TWILLIO_TOKEN | "" |
| TWILLIO_ACCOUNT_SID | "" |
| TWILLIO_SENDER | "" |
| TWILLIO_RECEIVER | "" |
| TWILLIO_TITLE | "" |
| TWILLIO_MESSAGE | "" |
## Email ## Email
Email uses username & password to authenticate for sending emails. Email uses username & password to authenticate for sending emails.
SMTP hostname i.e smtp.gmail.com and port i.e (587) should be provided as well for the server. SMTP hostname i.e smtp.gmail.com and port i.e (587) should be provided as well for the server.