Notify_twilio

Twilio

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

Account Setup

To use Twilio, you will need to acquire your Account SID and Auth Token. Both of these are accessible via the Twilio Dashboard.

You'll need to have a number defined as an Active Number (from your dashboard here). This will become your {FromPhoneNo} when identifying the details below.

Syntax

Valid syntaxes are as follows:

• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/{PhoneNo}
• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

If no ToPhoneNo is specified, then the FromPhoneNo will be messaged instead; hence the following is a valid URL:

• twilio://{AccountSID}:{AuthToken}@{FromPhoneNo}/

Short Codes are also supported but require at least 1 Target PhoneNo

• twilio://{AccountSID}:{AuthToken}@{ShortCode}/{PhoneNo}
• twilio://{AccountSID}:{AuthToken}@{ShortCode}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

Parameter Breakdown

Variable	Required	Description
AccountSID	Yes	The Account SID associated with your Twilio account. This is available to you via the Twilio Dashboard.
AuthToken	Yes	The Auth Token associated with your Twilio account. This is available to you via the Twilio Dashboard.
FromPhoneNo	*No	The Active Phone Number associated with your Twilio account you wish the SMS message to come from. It must be a number registered with Twilio. As an alternative to the FromPhoneNo, you may provide a ShortCode instead. The phone number MUST include the country codes dialling prefix as well when placed. 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.
ShortCode	*No	The ShortCode associated with your Twilio account you wish the SMS message to come from. It must be a number registered with Twilio. As an alternative to the ShortCode, you may provide a FromPhoneNo instead.
PhoneNo	*No	A phone number MUST include the country codes dialling prefix as well when placed. 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. Note: If you're using a ShortCode, then at least one PhoneNo MUST be defined.

Note: This notification service does not use the title field; only the body is passed along.

Examples

Send a Twilio Notification as an SMS:

# 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 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:

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