extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-06-27 05:01:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_twilio (markdown)

Chris Caron 2024-07-25 20:28:28 -04:00
parent 31055b8ec9
commit 0e86cf920c
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Notify_twilio.md

@ -21,6 +21,7 @@ If no _ToPhoneNo_ is specified, then the _FromPhoneNo_ will be messaged instead;
* **twilio**://**{AccountSID}**:**{AuthToken}**@**{ShortCode}**/**{PhoneNo}**
* **twilio**://**{AccountSID}**:**{AuthToken}**@**{ShortCode}**/**{PhoneNo1}**/**{PhoneNo2}**/**{PhoneNoN}**
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
@ -32,7 +33,30 @@ If no _ToPhoneNo_ is specified, then the _FromPhoneNo_ will be messaged instead;
**Note:** This notification service does not use the title field; only the _body_ is passed along.
#### Example
### WhatsApp Support
If your account is configured to support [WhatsApp for Buisness](https://www.twilio.com/en-us/messaging/channels/whatsapp) you can also use this plugin to notify those endpoints as well. Simply place a `w:` infront of the outbound phone numbers that should be delivered through WhatsApp instead of the default Twillio configuration: e.g:
```bash
# Assuming our {AccountSID} is AC735c307c62944b5a
# Assuming our {AuthToken} is e29dfbcebf390dee9
# Assuming our {FromPhoneNo} is +1-900-555-9999
# Assuming our WhatsApp {PhoneNo} is +1 555 123 3456
apprise -vv -t "Test Message Title" -b "Test Message Body" \
twilio://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/w:15551233456
# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \
twilio://AC735c307c62944b5a:e29dfbcebf390dee9@1-(900) 555-9999/w:+1 555 123 3456
```
You can also place a `w:` infront of your own phone number to switch the default behavior to interpret all of the numbers that follow to be sent to WhatsApp. For example: `twillio://credentials/w:18005559876/15551234444/15551235555`
In the above example, the target numbers `15551234444` and `15551235555` would have been sent through WhatsApp because the default switch of how to treat the numbers was switched by prefixing the source with `w:` instead.
**Note:** Sources with Short Codes will not work for WhatsApp.
#### More Examples
Send a Twilio Notification as an SMS:
```bash
# Assuming our {AccountSID} is AC735c307c62944b5a