quick_sms

module
v0.1.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 5, 2019 License: MIT

README

quick_sms

A simple service to send an sms to a phone number via email.

Built on top of:

  • go
  • echo

About

The most common use case for something like this is when you need to send an an SMS notification to a relatively small set of numbers, sometimes its better to use a larger service (like TWILLIO) if you need to send to a large set of numbers and the provider for the numbers is not known. Also this approach doesn't really work for messaging back and forth.


Setup

  • rename the .env-example to .env and replace the variables with your own
  • update the knownNumbers.json file with numbers you might expect to use.
  • if using gmail, the setup for unsafe apps needs to be set see this link

Dev

  • make any changes to code
  • use the ./scripts/run.sh to run locally

Docker

  • docker-compose up

Test

  • use postman or something to POST a body to https://127.0.0.1/sms

Example Payload

{
    "number":"5550003333",
    "message":"I have a belly button.",
    "provider":"T-Mobile" (optional)
}

if no provider is set, then the known numbers will be checked to get that info.

Directories

Path Synopsis
main
main

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL