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 Africas Talking Support #1167

Merged
merged 4 commits into from
Jul 18, 2024
Merged

Added Africas Talking Support #1167

merged 4 commits into from
Jul 18, 2024

Conversation

caronc
Copy link
Owner

@caronc caronc commented Jul 18, 2024

Description:

Related issue (if applicable): n/a

Added Africas Talking Support to Apprise

Account Setup

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

Syntax

Valid syntax is as follows:

  • atalk://{appuser}@{apikey}/{toPhoneNo}
  • atalk://{appuser}@{apikey}/{toPhoneNo1}/{toPhoneNo2}/{toPhoneNoN}

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 Your registered short code or alphanumeric; Defaults to AFRICASTKNG
batch No Send multiple specified notifications in a single batch (1 upstream post to the end server). By default this is set to no.
mode No Allows you to send your SMS under different modes; options are bulksms (default), premium, or sandbox.

New Service Completion Status

  • apprise/plugins/NotifyAfricasTalking.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@africastalking-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
 "atalk://appuser@apikey/target-phone-no"

@caronc caronc force-pushed the africastalking-support branch from 8ca4995 to 12e1fd2 Compare July 18, 2024 01:19
Copy link

codecov bot commented Jul 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.26%. Comparing base (313a70b) to head (5ea425c).

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #1167    +/-   ##
========================================
  Coverage   99.26%   99.26%            
========================================
  Files         142      143     +1     
  Lines       18460    18578   +118     
  Branches     3553     3573    +20     
========================================
+ Hits        18324    18442   +118     
  Misses        124      124            
  Partials       12       12            

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

@caronc caronc merged commit 7efb6c5 into master Jul 18, 2024
14 checks passed
@caronc caronc deleted the africastalking-support branch July 26, 2024 01:31
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.

1 participant