Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added SMS Manager Support #1018

Merged
merged 1 commit into from
Dec 17, 2023
Merged

Added SMS Manager Support #1018

merged 1 commit into from
Dec 17, 2023

Conversation

caronc
Copy link
Owner

@caronc caronc commented Dec 17, 2023

Description:

Related issue (if applicable): n/a

Added SMS Manager Support to Apprise

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

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:

  • smsmgr://{apikey}@/{toPhoneNo}
  • smsmgr://{apikey}@/{toPhoneNo1}/{toPhoneNo2}/{toPhoneNoN}

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

  • apprise/plugins/NotifySMSGateway.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@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
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

Additional details and impacted files
@@           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            

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@caronc caronc merged commit 2228bda into master Dec 17, 2023
12 checks passed
@caronc caronc deleted the sms-manager-support branch December 29, 2023 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants