PapiHack/orange-sms-sender-service

A simple microservice powered by FastAPI with orange sms API fully integrated that allow you to send sms very easily

โ˜… 1Forks 0PythonGitHub โ†—Compare

README

Orange SMS Sender API

python FastAPI Open Source Love png1 Issues PR

This is a simple and small microservice with the ORANGE SMS API fully integrated.

Requirements

  • Python

  • FastAPI

Setup

After pull or clone this repo you need to :

  • Install required dependecies by running the following command : pip install -r requirements.txt

  • Rename .env.example file to .env and fill parameters or variable defined in it

  • Run the following command : uvicorn main:app

  • Go to http://localhost:8000

Important Notes

Usage

  • The main endpoint that allow you to send sms is /api/v1/send-sms and need this payload :
{
  "phone_number": "the recipient's number",
  "message": "your message here"
}

TODO [WIP]

  • Dockerize the service

Screenshots

screenshot

Contributing

Feel free to make a PR or report an issue ๐Ÿ˜ƒ

Oh, one more thing, please do not forget to put a description when you make your PR ๐Ÿ™‚

Author

Contributors

PapiHackdependabot[bot]

Issues