Click to Call with Flask

This template is part of Twilio CodeExchange. If you encounter any issues with this code, please open an issue at github.com/twilio-labs/code-exchange/issues.

About

This is an application example implementing Click to Call using Twilio and Flask web framework.

Read the full tutorial here!

Implementations in other languages:

.NET	Java	Node	Ruby	PHP
Done	Done	Done	Done	Done

Set up

Requirements

• Python 3.6, 3.7 or 3.8 version.

In some environments when both version 2 and 3 are installed, you may substitute the Python executables below with python3 and pip3 unless you use a version manager such as pyenv.

Twilio Account Settings

This application should give you a ready-made starting point for writing your own application. Before we begin, we need to collect all the config values we need to run the application:

Config Value	Description
TWILIO_ACCOUNT_SID	Your primary Twilio account identifier - find this in the Console.
TWILIO_AUTH_TOKEN	Used to authenticate - just like the above, you'll find this here.
TWILIO_NUMBER	A Twilio phone number in E.164 format - you can get one here

Local development

1. First clone this repository and cd into it.

   git clone https://github.com/TwilioDevEd/clicktocall-flask.git
   cd clicktocall-flask

2. Create the virtual environment, load it and install the dependencies.

   make install

3. Copy the sample configuration file and edit it to match your configuration.

   cp .env.example .env

   See Twilio Account Settings to locate the necessary environment variables.

4. Start the development server, it will run on port 5000. Before running the following command, make sure the virtual environment is activated.

   make serve

5. Expose your application to the wider internet using ngrok. You can click here for more details. This step is important because the application won't work as expected if you run it through localhost.

   ngrok http 5000

6. Once Ngrok is running, open up your browser and go to your Ngrok URL. It will look like this: http://9a159ccf.ngrok.io

That's it!

Docker

If you have Docker already installed on your machine, you can use our docker-compose.yml to setup your project.

1. Make sure you have the project cloned.
2. Setup the .env file as outlined in the Local Development steps.
3. Run docker-compose up.
4. Follow the steps in Local Development on how to expose your port to Twilio using a tool like ngrok and configure the remaining parts of your application.

Tests

To execute tests, run the following command in the project directory. Before running the following command, make sure the virtual environment is activated.

make test

Cloud deployment

Additionally to trying out this application locally, you can deploy it to a variety of host services. Here is a small selection of them.

Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.

Service
Heroku

Resources

• The CodeExchange repository can be found here.

Contributing

This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.