Python SMS Quickstart

This quickstart serves as a guide to get your first SMS application up and running with FreeClimb.

Specifically, the project will:

• Receive an incoming message via a FreeClimb application
• Respond "Hello World!" to the incoming message

Tutorial

We offer a Python SMS Quickstart Tutorial for more detailed set-up instructions and explanation of how FreeClimb works.

Requirements

A FreeClimb account

A registered application with a named alias

A configured FreeClimb number assigned to your application

Trial accounts: a verified number

Tools:

• Python 3.5.0 or higher
• ngrok (recommended for hosting)
• pip

Setting up the Quickstart

1. Install the required packages

   pip install -r requirements.txt

2. Configure environment variables (in .env.sample and rename the file to .env):

   ENV VARIABLE	DESCRIPTION
   ACCOUNT_ID	Account ID which can be found under API credentials in dashboard.
   API_KEY	API key which can be found under API credentials in dashboard.
   FREECLIMB_NUMBER	The number that sends messages from your application. Your FreeClimb number.

3. Make your local server publicly accessible

   ngrok http 3000

   Once you run ngrok you should receive a response with a public URL, that looks something like 'https://ba1c-63-209-137-19.ngrok-free.app'.

4. Configure your applications's endpoints by adding a publicly accessible URL (we recommend an ngrok URL) and the route reference /incomingSms to your App Config's SMS URL field:

   https://YOUR-URL.ngrok.io/incomingSms

Running the Quickstart

1. Start your voice quickstart application

   python main.py

2. Text the FreeClimb number assigned to the application you've configured for this tutorial

Using Docker to Run the Quickstart

1. Pull docker image from dockerhub

   docker pull freeclimbapi/python-sms-quickstart

2. Run docker image after replacing placeholder values

   docker run -e ACCOUNT_ID=<YOUR_ACCOUNT_ID> -e API_KEY=<YOUR_API_KEY> -e FREECLIMB_NUMBER=<YOUR_FREECLIMB_NUMBER> -p 3000:3000 freeclimbapi/python-sms-quickstart

Feedback & Issues

If you would like to give the team feedback or you encounter a problem, please contact support or submit a ticket in the dashboard.