Exotel Support

[caronc]

Description:

Related issue (if applicable): #682

Exotel Apprise Support Added

• Website: https://exotel.com/
• API Reference: https://developer.exotel.com/

Setup

Sign up for Exotel from here. From your dashboard, you can acquire both the SID and API Token. This is all you need to use this through Apprise.

Syntax

Valid syntax is as follows:

• exotel://{sid}:{token}@{fromPhoneNo}
• exotel://{sid}:{token}@{fromPhoneNo}/{phoneNo}
• exotel://{sid}:{token}@{fromPhoneNo}/{phoneNo1}/{phoneNo2}/{phoneNoN}

Parameter Breakdown

Variable	Required	Description
sid	Yes	The SID associated with your Exotel Account.
token	Yes	The API Token associated with your Exotel 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	Specify the phone number you registered with Exotel you wish the message to be identified as being sent from.
batch	No	Send multiple specified notifications in a single batch (1 upstream post to the end server). By default this is set to no.
unicode	No	Optionally tell Apprise to not mark your text message as having unicode characters in it. The message mode changes to auto if this is set to No

New Service Completion Status

• apprise/plugins/NotifyExotel.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@682-exotel-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
  "exotel://sid:token@555-555-5555"

[codecov-commenter]

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (d1ebef5) compared to base (9a9703c).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##            master      #782    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          114       117     +3     
  Lines        14866     15092   +226     
  Branches      3045      3083    +38     
==========================================
+ Hits         14866     15092   +226     

Impacted Files	Coverage Δ
apprise/plugins/NotifyExotel.py	100.00% <100.00%> (ø)
apprise/plugins/NotifyMacOSX.py	100.00% <0.00%> (ø)
apprise/__init__.py	100.00% <0.00%> (ø)
apprise/common.py	100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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