A Python module for communicating with the Twilio API and generating TwiML.
Clone or download
Latest commit ba9de31 Sep 1, 2018
Permalink
Failed to load latest commit information.
docs move index and readme_include to root (#443) Aug 3, 2018
examples Fix region support Mar 27, 2017
tests [Librarian] Regenerated @ a116e3792e0654867f915a20c9ec8ac6e2385e9e Aug 31, 2018
twilio Release 6.16.4 Aug 31, 2018
.gitignore Auto generate docs with sphinx (#442) Aug 3, 2018
.travis.yml Fix all Docker image build and push issues (#433) Jul 4, 2018
AUTHORS.md Update changelog and authors for 6.8.1 Oct 20, 2017
CHANGES.md [Librarian] Regenerated @ a116e3792e0654867f915a20c9ec8ac6e2385e9e Aug 31, 2018
CONTRIBUTING.md Adding Beta and Preview products to main artifact Jul 27, 2017
Dockerfile Add Dockerfile and related changes to build the Docker image (#428) Jun 29, 2018
ISSUE_TEMPLATE.md [Librarian] Regenerated @ 61e059e9694883693c4919778c1e37947fdb3168 Jul 27, 2017
LICENSE.md [Librarian] Regenerated @ a4cb3dcc12627f0ab0fcc6104a6bed708e9375c4 Jan 20, 2018
MANIFEST.in Include the CA Cert when packaging python Sep 7, 2013
Makefile Auto generate docs with sphinx (#442) Aug 3, 2018
README.rst Add Dockerfile and related changes to build the Docker image (#428) Jun 29, 2018
UPGRADE.md Update changelog and upgrade guide for 6.7.0 Sep 28, 2017
VERSIONS.md [Librarian] Regenerated @ 61e059e9694883693c4919778c1e37947fdb3168 Jul 27, 2017
deploy.py Make sure to put a newline at the end of __init__.py Aug 3, 2016
index.rst move index and readme_include to root (#443) Aug 3, 2018
readme_include.rst move index and readme_include to root (#443) Aug 3, 2018
requirements.txt Add missing dependencies for running tests (#404) Jan 30, 2018
setup.cfg Flake8 ignore generated files Oct 23, 2017
setup.py Migrate readme to rst and load it in with setup.py (#417) May 25, 2018
tox.ini Drop Python 2.6 support Jun 2, 2017

README.rst

twilio-python

https://secure.travis-ci.org/twilio/twilio-python.png?branch=master

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

Feedback

Report any feedback or problems with this Release Candidate to the Github Issues for twilio-python.

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.