caronc / apprise

Apprise - Push Notifications that work with just about every platform!
https://hub.docker.com/r/caronc/apprise
BSD 2-Clause "Simplified" License
10.94k stars 385 forks source link

Added SMS Manager Support #1018

Closed caronc closed 6 months ago

caronc commented 6 months ago

Description:

Related issue (if applicable): n/a

Added SMS Manager Support to Apprise

Account Setup

Sign up for SMS Manager from here. You can access your API Key from the management section from your account.

Syntax

Valid syntax is as follows:

smsmanager:// can also be used as an alias to smsmgr:// if you choose.

Parameter Breakdown

Variable Required Description
apikey Yes The API Key associated with your SMS Manager Account.
to *No A phone number and/or group you wish to send your notification to. You can use comma's to separate multiple entries if you wish. This is an alias to targets.
from *No This requires approval from the Administrator and provides a sender option in the payload. It can not exceed 11 characters according to the documentation. You may also use ?sender= to set this same value.
batch No Send multiple specified notifications in a single batch (1 upstream post to the end server). By default this is set to no.
gateway No SMS Manager supports the following gateway settings: high, economy, low, and direct. By default this is set to high if not otherwise specified.

New Service Completion Status

Checklist

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@sms-manager-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
 "smsmgr://apikey/target-phone-no"
codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (cda6925) 99.55% compared to head (922b24d) 99.55%.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1018 +/- ## ======================================== Coverage 99.55% 99.55% ======================================== Files 130 131 +1 Lines 17281 17397 +116 Branches 3523 3545 +22 ======================================== + Hits 17204 17320 +116 Misses 68 68 Partials 9 9 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.