Burst SMS Support Added

[caronc]

Description:

Related issue (if applicable): n/a

Added Burst SMS Support

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

You need to have an account with Burst SMS. Visit your profile options and create a Secret to associate with your account. You'll notice that there is already an API Key present. These will be used for your credentials.

Burst SMS will set you up with a Sender ID that you're notifications will originate from. This must be provided as part of the Apprise URL as well.

Syntax

The syntax is as follows

• burstsms://{api_key}:{secret}@{sender_id}/{targets}

Parameter Breakdown

Variable	Required	Description
api_key	Yes	This is the API Key associated with your Bulk SMS Account
secret	Yes	This is the Client Secret associated with your Bulk SMS Account
sender_id	Yes	This is the Phone Number associated with your Bulk SMS Account.
targets	Yes	Optionally identify the phone numbers you wish to send your SMS Message to.
country	No	Optionally specify the countrycode which is either en, gb, au or nz. By default this is set to us
validity	No	Optionally define how long an unsent SMS message is valid for (and will be attempted to be resent). By default this is set to zero (0) for the maximum amount of validity. This value is defined in minutes.
batch	No	Optionally send notifications in a batch (vs individually). By default this is set to No.

New Service Completion Status

• apprise/plugins/NotifyBurstSMS.py
• KEYWORDS
  • add new service into this file (alphabetically).
• README.md
  • add entry for new service to table (as a quick reference)
• packaging/redhat/python-apprise.spec
  • add new service into the %global common_description

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• No lint errors (use flake8)
• 100% test coverage

Testing

Anyone can help test this source code as follows:

# Create a virtual environment to work in as follows:
python3 -m venv apprise

# Change into our new directory
cd apprise

# Activate our virtual environment
source bin/activate

# Install the branch
pip install git+https://github.com/caronc/apprise.git@burstsms-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
  "burstsms://key:secret@sender_id/target_no"

[codecov-commenter]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (f1d0e9b) 99.98% compared to head (edc3c20) 99.98%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@           Coverage Diff            @@
##           master     #898    +/-   ##
========================================
  Coverage   99.98%   99.98%            
========================================
  Files         118      119     +1     
  Lines       15692    15828   +136     
  Branches     3207     3233    +26     
========================================
+ Hits        15690    15826   +136     
  Misses          1        1            
  Partials        1        1            

Impacted Files	Coverage Δ
apprise/plugins/NotifyBurstSMS.py	100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.