Skip to content
A Python module for communicating with the Twilio API and generating TwiML.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Prepend the repo root to the system paths during doc generation (#465) Apr 22, 2019
examples Fix region support Mar 27, 2017
tests [Librarian] Regenerated @ a7fa662b873c238736743a9396578a110b073193 Jul 10, 2019
twilio Release 6.29.1 Jul 10, 2019
.gitignore Auto generate docs with sphinx (#442) Aug 3, 2018
.travis.yml Add py37 to TravisCI config (#459) Mar 29, 2019
AUTHORS.md Update changelog and authors for 6.8.1 Oct 20, 2017
CHANGES.md [Librarian] Regenerated @ a7fa662b873c238736743a9396578a110b073193 Jul 10, 2019
CONTRIBUTING.md Adding Beta and Preview products to main artifact Jul 27, 2017
Dockerfile Migrate the README to markdown (#463) Apr 22, 2019
ISSUE_TEMPLATE.md [Librarian] Regenerated @ 61e059e9694883693c4919778c1e37947fdb3168 Jul 27, 2017
LICENSE.md [Librarian] Regenerated @ 72a4a03cce4b243aa46f00ba60b80ffae1ffcb31 Jan 2, 2019
MANIFEST.in Include the CA Cert when packaging python Sep 7, 2013
Makefile Auto generate docs with sphinx (#442) Aug 3, 2018
README.md Migrate the README to markdown (#463) Apr 22, 2019
UPGRADE.md Update changelog and upgrade guide for 6.7.0 Sep 28, 2017
VERSIONS.md [Librarian] Regenerated @ 61e059e9694883693c4919778c1e37947fdb3168 Jul 27, 2017
index.rst Migrate the README to markdown (#463) Apr 22, 2019
requirements.txt Add missing dependencies for running tests (#404) Jan 30, 2018
setup.cfg Flake8 ignore generated files Oct 23, 2017
setup.py Add py37 to classifiers Jul 11, 2019
tox.ini Drop Python 2.6 support Jun 2, 2017

README.md

twilio-python

Build Status PyPI PyPI

A module for using the Twilio REST API and generating valid TwiML.

Recent Update

As of release 6.5.0, Beta and Developer Preview products are now exposed via the main twilio-python artifact. Releases of the alpha branch have been discontinued.

If you were using the alpha release line, you should be able to switch back to the normal release line without issue.

If you were using the normal release line, you should now see several new product lines that were historically hidden from you due to their Beta or Developer Preview status. Such products are explicitly documented as Beta/Developer Preview both in the Twilio docs and console, as well as through in-line code documentation here in the library.

Installation

Install from PyPi using pip, a package manager for Python.

pip install twilio

Don't have pip installed? Try installing it, by running this from the command line:

$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python

Or, you can download the source code (ZIP) for twilio-python, and then run:

python setup.py install

You may need to run the above commands with sudo.

Migrate from 5.x

Please consult the official migration guide for information on upgrading your application using twilio-python 5.x to 6.x

Getting Started

Getting started with the Twilio API couldn't be easier. Create a Client and you're ready to go.

API Credentials

The Twilio needs your Twilio credentials. You can either pass these directly to the constructor (see the code below) or via environment variables.

from twilio.rest import Client

account = "ACXXXXXXXXXXXXXXXXX"
token = "YYYYYYYYYYYYYYYYYY"
client = Client(account, token)

Alternately, a Client constructor without these parameters will look for TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN variables inside the current environment.

We suggest storing your credentials as environment variables. Why? You'll never have to worry about committing your credentials and accidentally posting them somewhere public.

from twilio.rest import Client
client = Client()

Make a Call

from twilio.rest import Client

account = "ACXXXXXXXXXXXXXXXXX"
token = "YYYYYYYYYYYYYYYYYY"
client = Client(account, token)

call = client.calls.create(to="9991231234",
                           from_="9991231234",
                           url="http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient")
print(call.sid)

Send an SMS

from twilio.rest import Client

account = "ACXXXXXXXXXXXXXXXXX"
token = "YYYYYYYYYYYYYYYYYY"
client = Client(account, token)

message = client.messages.create(to="+12316851234", from_="+15555555555",
                                 body="Hello there!")

Handling a call using TwiML

To control phone calls, your application needs to output TwiML. Use twilio.twiml.Response to easily create such responses.

from twilio.twiml.voice_response import VoiceResponse

r = VoiceResponse()
r.say("Welcome to twilio!")
print(str(r))
<?xml version="1.0" encoding="utf-8"?>
<Response><Say>Welcome to twilio!</Say></Response>

Docker Image

The Dockerfile present in this repository and its respective twilio/twilio-python Docker image are currently used by Twilio for testing purposes only.

Getting help

If you need help installing or using the library, please check the Twilio Support Help Center first, and file a support ticket if you don't find an answer to your question.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!

You can’t perform that action at this time.