extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-06-26 20:51:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_twilio (markdown)

Chris Caron 2024-07-25 20:29:13 -04:00
parent 0e86cf920c
commit 424839ca29
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Notify_twilio.md

@ -33,6 +33,24 @@ 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.
#### Examples
Send a Twilio Notification as an SMS:
```bash
# Assuming our {AccountSID} is AC735c307c62944b5a
# Assuming our {AuthToken} is e29dfbcebf390dee9
# Assuming our {FromPhoneNo} is +1-900-555-9999
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
twilio://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/18005551223
# 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/1-(800) 555-1223
```
### 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
@ -55,21 +73,3 @@ You can also place a `w:` infront of your own phone number to switch the default
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
# Assuming our {AuthToken} is e29dfbcebf390dee9
# Assuming our {FromPhoneNo} is +1-900-555-9999
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
twilio://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/18005551223
# 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/1-(800) 555-1223
```