extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 22:11:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_clicksend (markdown)

Chris Caron 2020-07-31 23:11:57 -04:00
parent f8cfe81e6e
commit b7465c6010
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Notify_clicksend.md

@ -6,16 +6,16 @@
### Syntax
Valid syntaxes are as follows:
* **clicksend**://**{user}**:**{password}**@/**{PhoneNo}**
* **clicksend**://**{user}**:**{password}**@**{PhoneNo1}**/**{PhoneNo2}**/**{PhoneNoN}**
* `clicksend://{user}:{password}@/{PhoneNo}`
* `clicksend://{user}:{password}@{PhoneNo1}/{PhoneNo2}/{PhoneNoN}`
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
| user | Yes | The _username_ associated with your ClickSend account.
| password | Yes | The _password_ associated with your ClickSend account.
| PhoneNo | Yes | At least one phone number MUST identified to use this plugin. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion.
| batch | No | ClickSend allows a batch mode. If you identify more then one phone number, you can send all of the phone numbers you identify on the URL in a single shot instead of the normal _Apprise_ approach (which sends them one by one). Enabling batch mode has both it's pro's and cons. By default batch mode is disabled.
| user | Yes | The _username_ associated with your ClickSend account.
| password | Yes | The _password_ associated with your ClickSend account.
| PhoneNo | Yes | At least one phone number MUST identified to use this plugin. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion.
| batch | No | ClickSend allows a batch mode. If you identify more then one phone number, you can send all of the phone numbers you identify on the URL in a single shot instead of the normal _Apprise_ approach (which sends them one by one). Enabling batch mode has both it's pro's and cons. By default batch mode is disabled.
#### Example
Send a ClickSend Notification as an SMS:
@ -24,9 +24,11 @@ Send a ClickSend Notification as an SMS:
# Assuming our {password} is appriseIsAwesome
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223
apprise clicksend://l2g:appriseIsAwesome@18005551223
apprise -t "Test Message Title" -b "Test Message Body" \
clicksend://l2g:appriseIsAwesome@18005551223
# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise clicksend://l2g:appriseIsAwesome@1-(800) 555-1223
apprise -t "Test Message Title" -b "Test Message Body" \
clicksend://l2g:appriseIsAwesome@1-(800) 555-1223
```