README.md

MercurySMS

Dynamically extract phone numbers from a defined Google Sheets to send bulk messages with Twilio.

Note

Your Twilio phone number can be blacklisted as spam by carriers if you're sending bulk SMS. Read this FAQ. If you plan on sending bulk SMS on a regular basis, this is not the right software. You should consider obtaining and using short codes to avoid being blacklisted. They are also much faster than a normal Twilio phone number. HackCU and its developers are not responsible if you get blacklisted while using this tool.

This was built for a hackathon and will be used only for about 2 days in a year to send notifications to participants (who are aware of this and voluntarily provide their phone numbers). So, if your use case is similar, you shouldn't run into any issues of being blocked by carriers.

Setup

Needs: Python 3.X

$ pip install -r requirements.txt
$ python manage.py migrate
$ python manage.py createsuperuser

Run server

Local environment

Add 4 (2 optional) environment variables:

• ACCOUNT_TWILIO: Twilio account SID. Find it here
• TOKEN_TWILIO: Twilio account Auth Token. Find it here
• TWILIO_SERVICE_ID: Twilio Notify service SID
• SHEETS_KEY: Google Sheets key. Ex: https://docs.google.com/spreadsheets/d/**ajksdhalksdhalksdhlaksjawdlS83zL3I**/edit
• SHEETS_GID(optional): Tab that you want to extract from Google Sheets. Defaults to 0, first tab. You can find it on the URL. Ex: https://docs.google.com/spreadsheets/d/1Fo58xcUnCUN2-_1Rjua2lW6b85IDQ2gK9wdlS83zL3I/edit#**gid=0**
• PROD(optional): Run project on production mode. Any value will make it run as production mode.

Run server to 0.0.0.0

$ python manage.py runserver 0.0.0.0:8000

Usage

Set up Twilio

Follow this guide so the system can work.

Create Google Sheets

Create a Google Sheets. Open to public for viewing.

Add lists to Google Sheets

A list is a column in the mentioned Google Sheets. It is identified by each first row of a column. The rest of the rows must be the phone numbers.

Send SMS to list

• Open root route. Ex: http://localhost:8000
• Login with user (you can login with the super user you created in your first steps)
• Send messages right away.

Add new users

• Login with admin user
• Enter admin interface. Ex: http://localhost:8000/admin
• Add new user there

Future

• Add ability to receive SMS
• Answer SMS received individually
• Keep a log of all messages sent and recipients