Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

IVR: Phone Tree with Python and Flask

Download the Code

ET Phone Home: IVR Python & Flask Example

This Python Flask sample application is modeled after a typical call center experience, but with more Reese's Pieces.

Stranded aliens can call a phone number and receive instructions on how to get out of earth safely, or call their home planet directly. In this tutorial, we'll show you the critical bits of code that make this work.

To run this sample app yourself, download the code and follow the instructions on GitHub. You can also look at this GitHub repository to see how we've structured our application's file structure.

Read how Livestream and others built Interactive Voice Response with Twilio. Find source code for many web frameworks on our IVR tutorial page.

Click here to start the tutorial!

Answering a Phone Call

To initiate the phone tree, we need to configure one of our Twilio numbers to send our web application an HTTP request when we get an incoming call.

Click on one of your numbers and configure the Voice URL to point to our app. In our code, the route will be /ivr/welcome.

IVR Webhook Configuration

If you don't already have a server configured to use as your webhook, ngrok is an excellent tool for testing webhooks locally.

With our Twilio number configured, we are prepared to respond to the Twilio request.

Respond to Twilio with TwiML

Respond to the Twilio request with TwiML

Our Twilio number is now configured to send HTTP requests to this controller method on any incoming voice calls. Our app responds with TwiML to tell Twilio what to do in response to the message.

In this case, we tell Twilio to Gather the input from the caller and then Play a welcome message.

You may have noted we're using an unknown method, `TwiML`. This method comes from a custom view helper that takes a TwiML Response and transforms it into a valid HTTP Response. Check out the implementation:

import flask

def twiml(resp):
    resp = flask.Response(str(resp))
    resp.headers['Content-Type'] = 'text/xml'
    return resp
Loading Code Sample...
      
      
          
          
          
          
        
      ivr_phone_tree_python/views.py

      To see the full layout of this app, you can check out its file structure in the GitHub repository.

      After playing the audio and retrieving the caller's input, Twilio will send this input to our application.

      See where to send the caller's input

      Where to send the caller's input

      The gather's action parameter takes an absolute or relative URL as a value - in our case, this is the menu endpoint.

      When the caller finishes entering digits, Twilio will make a GET or POST request to this URL and include a Digits parameter with the number our caller chose.

      After making its request, Twilio will continue the current call using the TwiML received in your response. Note that any TwiML verbs occurring after a <Gather> are unreachable unless the caller does not enter any digits.

      Loading Code Sample...
          
          
              
              
              
              
            
          ivr_phone_tree_python/views.py

          Send caller input to the intended route

          ivr_phone_tree_python/views.py

          Now that we have told Twilio where to send the caller's input, we can look at how to process that input.

          Process the caller's selection

          The Main Menu: Processing the caller's selection

          This route handles processing the caller's input.

          If our caller chooses '1' for directions, we use the _give_instructions method to respond with TwiML that will Say directions to our caller's extraction point.

          If the caller chooses '2' to call their home planet, then we need to gather more input from them. We wrote another method to handle this, _list_planets, which we'll cover in the next step.

          If the caller enters anything else, we respond with a TwiML Redirect to the main menu.

          Loading Code Sample...
              
              
                  
                  
                  
                  
                
              ivr_phone_tree_python/views.py

              Main menu and return instructions

              ivr_phone_tree_python/views.py

              If the caller chooses '2', we will take them to the Planet Directory to collect more input.

              Get more input from your caller

              The Planet Directory: Collecting more input from the caller

              If our callers choose to call their home planet, we will read them the planet directory. Our planet directory is similar to a typical "company directory" feature of most IVRs.

              In our TwiML response, we again use a Gather verb to get our caller's input. This time, the action verb points to the planets route, which will map our response to what the caller chooses.

              Let's look at that route next. The TwiML response we return for that route uses a Dial verb with the appropriate phone number to connect our caller to their home planet.

              Loading Code Sample...
                  
                  
                      
                      
                      
                      
                    
                  ivr_phone_tree_python/views.py

                  Again, we show some options to the caller and instruct Twilio to collect the caller's choice.

                  See how we use the caller's input to call another number

                  The Planet Directory: Connect the caller to another number

                  In this route, we grab the caller's digit selection from the HTTP request and store it in a variable called selected_option. We then use a Dial verb with the appropriate phone number to connect our caller to their home planet.

                  The current numbers are hardcoded, but you could update this code to read phone numbers from a database or a file.

                  Loading Code Sample...
                      
                      
                          
                          
                          
                          
                        
                      ivr_phone_tree_python/views.py

                      Connect to another number based on caller input

                      ivr_phone_tree_python/views.py

                      That's it! We've just implemented an IVR phone tree that will help get ET back home.

                      What's next?

                      Where to Next?

                      If you're a Python/Flask developer working with Twilio, you might want to check out these other tutorials:

                      Appointment Reminders

                      Use Twilio to automate the process of reaching out to your customers in advance of an upcoming appointment.

                      Two-Factor Authentication with Authy

                      Use Twilio and Twilio-powered Authy OneTouch to implement two-factor authentication (2FA) in your web app

                      Did this help?

                      Thanks for checking out this tutorial! If you have any feedback to share with us, we'd love to hear it. Connect with us on Twitter and let us know what you build!

                      Kevin Whinnery Jennifer Aprahamian Agustin Camino Samuel Mendes Andrew Baker Paul Kamp  Kat King

                      Need some help?

                      We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                      Loading Code Sample...