Skip to content

A python(flask) sms client that allows sending of sms via either Nexmo or Africastalking

Notifications You must be signed in to change notification settings

Psycadelik/NexAT-SMS

Repository files navigation

SMS Client Api

Build Status

This is an sms service that provides endpoints for sending sms via either Nexmo or AfricasTalking

Here's the basic directory structure;

├── app
│    ├── config.py
│    ├── __init__.py
│    ├── africastalking.py
│    ├── nexmo.py
│    ├── uncharted.py
│    ├── tasks.py
│    
├── README.md
├── requirements.txt
├── test
│   └── __init__.py
└── app.py
├── Dockerfile
├── .env
├── .travis.yml

Project Set up

  • clone this repository
  • cd into project folder
  • create a virtual environment i.e virtualenv venv
  • activate virtual environment i.e source venv/bin/activate
  • run pip install -r requirements.txt
  • create a .env file in the root of the project and add the following:
     export NEXMO_API_KEY=YOUR-NEXMO-API-KEY  
     export NEXMO_API_SECRET=YOUR-NEXMO-API-SECRET  
     export AT_USERNAME=YOUR-AFRICASTALKING-USERNAME   
     export AT_API_KEY=YOUR-AFRICASTALKING-API-KEY   
     export AT_SHORTCODE=YOUR-AFRICASTALKING-SHORTCODE
     
    
  • run unit tests : python -m unittest discover
  • start the project : python app.py
  • open postman and navigate to the url : http://127.0.0.1:5000/sendsms
  • add the payload as json:
       {              
          "provider": "nexmo(or africastalking)",           
          "sms": "your message",
          "recipient": 254723123456        
       }   
    

About

A python(flask) sms client that allows sending of sms via either Nexmo or Africastalking

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published