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

httpSMS Support Added #1017

Merged
merged 1 commit into from
Dec 17, 2023
Merged

httpSMS Support Added #1017

merged 1 commit into from
Dec 17, 2023

Conversation

caronc
Copy link
Owner

@caronc caronc commented Dec 16, 2023

Description:

Related issue (if applicable): #938

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

Account Setup

Sign up for httpSMS from here. You will be then be able to access the /settings section of your account to obtain your API Key which you will need to use the Apprise Integration with (as {apikey})

Syntax

Valid syntax is as follows:

  • httpsms://{apikey}@{fromPhoneNo}
  • httpsms://{apikey}@{fromPhoneNo}/{target}

Parameter Breakdown

Variable Required Description
apikey Yes The API Key associated with your httpSMS Account (visit here to acquire it).
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 Specify the phone number you registered with httpSMS you wish the message to be identified as being sent from.

New Service Completion Status

  • apprise/plugins/NotifyHttpSMS.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@938-httpsms-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
  "httpsms://apikey@from_number/to_number"

@caronc
Copy link
Owner Author

caronc commented Dec 16, 2023

@AchoArnold: httpSMS support added in this Pull Request. would you be able to confirm it works for me? Instructions can be found here.

@codecov-commenter
Copy link

codecov-commenter commented Dec 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (524eba6) 99.52% compared to head (cb1314b) 99.52%.

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

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1017   +/-   ##
=======================================
  Coverage   99.52%   99.52%           
=======================================
  Files         129      130    +1     
  Lines       17189    17285   +96     
  Branches     3510     3525   +15     
=======================================
+ Hits        17107    17203   +96     
  Misses         70       70           
  Partials       12       12           

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

@AchoArnold
Copy link

Hello @caronc

I tested locally and it works as expected.

You have a typo in the test command is should be @ instead of /

apprise -t "Test Title" -b "Test Message"  "httpsms://xxxxxxxxx@1941xxxxxxx/194xxxxxx"

@caronc
Copy link
Owner Author

caronc commented Dec 17, 2023

@AchoArnold Thank you so much for testing so quickly 🚀 . I fixed the typo and verified it wasn't in the code as well. So we're good. Merging to Master!

@caronc caronc merged commit a175f16 into master Dec 17, 2023
12 checks passed
@caronc caronc deleted the 938-httpsms-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.

3 participants