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?

Warm Transfer with Python and Flask

Download the Code

Have you ever been disconnected from a support call while being transferred to someone else? That couldn't have left a great impression on you...

Warm transfer eliminates this problem - it allows your agents to have the ability to dial in another agent in real time.

Today we'll add warm transfer to a Python and Flask application so we can engender warm feelings among customers talking to support.

Here's how it works at a high level:

  1. The first agent becomes available by connecting through the web client.
  2. The second agent becomes available by connecting through the web client.
  3. A customer calls our support line.
  4. The client stays on hold while the first agent joins the call.
  5. While the first agent is on the phone with the client, he or she dials the second agent into the call.
  6. Once the second agent is on the call, the first one can disconnect. The client and the second agent stay on the call.

Let's get started! Clone the sample application from Github, and click the button below to begin.

We're Warming Up

Set Up The Voice Web Hook

First, let's configure the voice web-hook for the Twilio number that customers will dial when they want to talk to a support agent.

Twilio Console for Warm Transfer

In production, this should be the public-facing URL for your app.

One option to expose a development URL from your local machine is to use ngrok. Your URL would then be something like:

https://<your-ngrok-id>.ngrok.io/conference/connect/client

Loading Code Sample...
      
      
      
      
      warm_transfer_flask/views.py

      Route for our Twilio webhook

      warm_transfer_flask/views.py

      Awesome, now you've got a webhook in place. Next up, we'll look at some of the code.

      Next

      Connect an Agent to a Call

      Here you can see all front-end code necessary to connect an agent using Twilio's Voice Web Client.

      We need three things to have a live web client:

      • A capability token (provided by our Flask app)
      • A unique identifier (string) for each agent
      • Event listeners to handle different Twilio-triggered events
      Loading Code Sample...
          
          
          
          
          warm_transfer_flask/static/js/main.js

          Create a new call from the browser

          warm_transfer_flask/static/js/main.js

          In the next step we'll take a closer look at capability token generation.

          Next

          Generate a Capability Token

          In order to connect the Twilio Voice Web Client we need a capability token.

          To allow incoming connections through the web client an identifier must be provided when generating the token.

          Loading Code Sample...
              
              
              
              
              warm_transfer_flask/token.py

              Generate a capability token

              warm_transfer_flask/token.py

              Next up let's see how to handle incoming calls.

              Next

              Handle Incoming Calls

              For this tutorial we used fixed identifier strings like agent1 and agent2 but you can use any unique application generated string for your call center clients. These identifiers will be used to create outbound calls to the specified agent using the Twilio REST API.

              When a client makes a call to our Twilio number the application receives a POST request asking for instructions. We'll use TwiML to instruct the client to join a conference room and use the Twilio REST API client to invite (and initiate a call to) the first agent.

              When providing instructions to the client, we also provide a waitUrl. This URL is another end point of our application and will return more TwiML to SAY welcome to the user and also PLAY some music while on hold. Take a look at the code here.

              We use the client's CallSid as the conference identifier. Since all participants need this identifier to join the conference, we'll need to store it in a database so that we can grab it when we dial the second agent into the conference.

              Loading Code Sample...
                  
                  
                  
                  
                  warm_transfer_flask/views.py

                  Now let's see how to provide TwiML instructions to the client.

                  Next

                  Provide TwiML Instructions For The Client

                  Here we create a TwiMLResponse that will contain a DIAL verb with a CONFERENCE noun that will instruct the JavaScript client to join a specific conference room.

                  Loading Code Sample...
                      
                      
                      
                      
                      warm_transfer_flask/twiml_generator.py

                      Provide TwiML instructions to the client

                      warm_transfer_flask/twiml_generator.py

                      Next up, we will look at how to dial our first agent into the call.

                      Bring in the First Agent

                      Dial The First Agent Into the Call

                      For our app we created a call module to handle dialing our agents. This module uses Twilio's REST API to create a new call. The create method receives the following parameters:

                      1. from_: Your Twilio number
                      2. to: The agent web client's identifier (agent1 or agent2)
                      3. url: A URL to ask for TwiML instructions when the call connects

                      Once the agent answers the call in the web client, a request is made to the callback URL instructing this call to join the conference where the client is already waiting.

                      Loading Code Sample...
                          
                          
                          
                          
                          warm_transfer_flask/call.py

                          Dial an agent into the call

                          warm_transfer_flask/call.py

                          With that in mind, let's see how to add the second agent to the call.

                          Next

                          Dial The Second Agent Into the Call

                          When the client and the first agent are both in the call we are ready to perform the warm transfer to a second agent.

                          The first agent makes a request passing its identifier to allow us to look for the conference_id needed to invite the second agent. Since we already have a call module, we can simply use the call_agent function to connect the second agent.

                          Loading Code Sample...
                              
                              
                              
                              
                              warm_transfer_flask/views.py

                              Invite a second agent to the conference

                              warm_transfer_flask/views.py

                              Next up, we'll look at how to handle the first agent leaving the call.

                              Next

                              The First Agent Leaves the Call

                              When the three participants have joined the same call, the first agent has served his or her purpose. Now agent #1 can drop the call, leaving agent #2 and the client to discuss support matters.

                              It is important to notice the differences between the TwiML each one of the participants received when joining the call:

                              • Both agent one and two have startConferenceOnEnter set to true.
                              • For the client calling and for agent two, endConferenceOnExit is set to true.

                              Translated, this means a conference will start when either agent joins the call. It also means the client or agent #2 disconnecting will hang up the call.

                              Loading Code Sample...
                                  
                                  
                                  
                                  
                                  warm_transfer_flask/twiml_generator.py

                                  Instruction to dial into a conference call

                                  warm_transfer_flask/twiml_generator.py

                                  And that's it!

                                  We have just implemented warm transfers using Python and Flask. Now your clients won't get disconnected from support calls while they are being transferred.

                                  Now let's look at some other great features Twilio makes it easy to add.

                                  Next

                                  Where to Next?

                                  If you're a Python developer working with Twilio you'll almost certainly love these tutorials:

                                  Automated Survey

                                  Instantly collect structured data from your users with a survey conducted over a call or SMS text messages.

                                  Browser Calls

                                  Learn how to use Twilio Client to make browser-to-phone and browser-to-browser calls with ease.

                                  Did this help?

                                  Thanks for checking this tutorial out! Let us know on Twitter what you've built... or what you're building.

                                  Agustin Camino Samuel Mendes Paul Kamp Andrew Baker  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...