4 Notify_clicksend
Chris Caron edited this page 2023-06-17 14:46:16 -04:00

ClickSend

  • Source: https://clicksend.com
  • Icon Support: No
  • Message Format: Text
  • Message Limit: 160 Characters per message

Syntax

Valid syntaxes are as follows:

  • 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.

Example

Send a ClickSend Notification as an SMS:

# Assuming our {user} is l2g
# Assuming our {password} is appriseIsAwesome
# 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" \
   "clicksend://l2g:appriseIsAwesome@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" \
   "clicksend://l2g:appriseIsAwesome@1-(800) 555-1223"