Create Conference Calls in Python

An XML response for a conference call with TwiML

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
  <Dial>
4
    <Conference>My conference</Conference>
5
  </Dial>
6
</Response>

A handy tool we provide to host static TwiML from the Twilio Console is called TwiML Bin.

Just go to the TwiML Bin page in the Developer Center and click the plus button to create a new TwiML Bin. You can then add any static TwiML you want to host. Here's an example:

Expand image

Click "Save" and your TwiML Bin is ready to use with any of your Twilio phone numbers.

With our TwiML created and placed in a TwiMLBin, let's configure a phone number with it.

In the Twilio Console, you can search for and buy phone numbers in countries around the world. Numbers that have the Voice capability can make and receive voice phone calls from just about anywhere on the planet.

Expand image

Once you purchase a number, you'll need to configure that number to send a request to your web application. This callback mechanism is called a webhook. This can be done in the number's configuration page.

Expand image

Now give your number a call. You'll hear hold music when you first join — call in from another phone number and the conference call will begin.

TwiML Bins are great for setting up conference call lines, but with the power of Python we can do so much more. Let's see how.

Expand image

When a phone number you have bought through Twilio receives an incoming call, Twilio will send an HTTP request to your web application asking for instructions on how to handle the call. Your server will respond with an XML document containing TwiML that instructs Twilio on what to do with the call. Those instructions can direct Twilio to read out a message, play an MP3 file, make a recording and much more.

To start answering phone calls, you must:

• Buy and configure a Twilio-powered phone number capable of making and receiving phone calls, and point it at your web application
• Write a web application to tell Twilio how to handle the incoming call using TwiML
• Make your web application accessible on the Internet so Twilio can make an HTTP request when you receive a call

Now comes the fun part - writing code that will handle an incoming HTTP request from Twilio!

In this example we'll use the Flask web framework to respond to Twilio's request and we'll use the Twilio Python SDK to generate our TwiML.

1
"""Demonstration of setting up a conference call in Flask with Twilio."""
2
from flask import Flask, request
3
from twilio.twiml.voice_response import VoiceResponse, Dial
4

5
app = Flask(__name__)
6

7
# Update with your own phone number in E.164 format
8
MODERATOR = '+18005551212'
9

10

11
@app.route("/voice", methods=['GET', 'POST'])
12
def call():
13
    """Return TwiML for a moderated conference call."""
14
    # Start our TwiML response
15
    response = VoiceResponse()
16

17
    # Start with a <Dial> verb
18
    with Dial() as dial:
19
        # If the caller is our MODERATOR, then start the conference when they
20
        # join and end the conference when they leave
21
        if request.values.get('From') == MODERATOR:
22
            dial.conference(
23
                'My conference',
24
                start_conference_on_enter=True,
25
                end_conference_on_exit=True)
26
        else:
27
            # Otherwise have the caller join as a regular participant
28
            dial.conference('My conference', start_conference_on_enter=False)
29

30
    response.append(dial)
31
    return str(response)
32

33
if __name__ == "__main__":
34
    app.run(debug=True)

In this example we use a couple advanced <Conference> features to allow one participant, our "moderator," to better control the call:

• startConferenceOnEnter will keep all other callers on hold until the moderator joins
• endConferenceOnExit will cause Twilio to end the call for everyone as soon as the moderator leaves

We use the "From" argument on Twilio's webhook request to identify whether the current caller should be the moderator or just a regular participant.

In order for the webhooks in this code sample to work, Twilio must be able to send your web application an HTTP request over the Internet. Of course, that means your application needs to have a URL or IP address that Twilio can reach.

In production you probably have a public URL, but you probably don't during development. That's where ngrok comes in. ngrok gives you a public URL for a local port on your development machine, which you can use to configure your Twilio webhooks as described above.

Once ngrok is installed, you can use it at the command line to create a tunnel to whatever port your web application is running on. For example, this will create a public URL for a web application listening on port 3000.

ngrok http 3000

After executing that command, you will see that ngrok has given your application a public URL that you can use in your webhook configuration in the Twilio console.

Expand image

Grab your ngrok public URL and head back to the phone number you configured earlier. Now let's switch it from using a TwiML Bin to use your new ngrok URL. Don't forget to append the URL path to your actual TwiML logic! ("http://<your ngrok subdomain>.ngrok.io/voice" for example)

Expand image

You're now ready to host dynamic conference calls with your Flask app. Grab some friends and give it a try!

We just scratched the surface of what you can do with conference calls and your Python application. Check out the full <Conference> reference documentation to learn about things like:

• Muting participants

• Recording conferences

• Using status callbacks to get notified when callers enter and leave the conference