• Stars
    star
    1,707
  • Rank 27,339 (Top 0.6 %)
  • Language
    Python
  • License
    MIT License
  • Created about 15 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Python module for communicating with the Twilio API and generating TwiML.

twilio-python

Tests PyPI PyPI Learn OSS Contribution in TwilioQuest

Documentation

The documentation for the Twilio API can be found here.

The Python library documentation can be found here.

Versions

twilio-python uses a modified version of Semantic Versioning for all changes. See this document for details.

Supported Python Versions

This library supports the following Python implementations:

  • Python 3.7
  • Python 3.8
  • Python 3.9
  • Python 3.10
  • Python 3.11

Installation

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

pip3 install twilio

If pip install fails on Windows, check the path length of the directory. If it is greater 260 characters then enable Long Paths or choose other shorter location.

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

curl https://bootstrap.pypa.io/get-pip.py | python

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

python3 setup.py install

Info If the command line gives you an error message that says Permission Denied, try running the above commands with sudo (e.g., sudo pip3 install twilio).

Test your installation

Try sending yourself an SMS message. Save the following code sample to your computer with a text editor. Be sure to update the account_sid, auth_token, and from_ phone number with values from your Twilio account. The to phone number will be your own mobile phone.

from twilio.rest import Client

# Your Account SID and Auth Token from console.twilio.com
account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
auth_token  = "your_auth_token"

client = Client(account_sid, auth_token)

message = client.messages.create(
    to="+15558675309",
    from_="+15017250604",
    body="Hello from Python!")

print(message.sid)

Save the file as send_sms.py. In the terminal, cd to the directory containing the file you just saved then run:

python3 send_sms.py

After a brief delay, you will receive the text message on your phone.

Warning It's okay to hardcode your credentials when testing locally, but you should use environment variables to keep them secret before committing any code or deploying to production. Check out How to Set Environment Variables for more information.

Use the helper library

API Credentials

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

Authenticating with Account SID and Auth Token:

from twilio.rest import Client

account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
auth_token  = "your_auth_token"
client = Client(account_sid, auth_token)

Authenticating with API Key and API Secret:

from twilio.rest import Client

api_key = "XXXXXXXXXXXXXXXXX"
api_secret = "YYYYYYYYYYYYYYYYYY"
account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
client = Client(api_key, api_secret, account_sid)

Alternatively, 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()

Specify Region and/or Edge

To take advantage of Twilio's Global Infrastructure, specify the target Region and/or Edge for the client:

from twilio.rest import Client

client = Client(region='au1', edge='sydney')

A Client constructor without these parameters will also look for TWILIO_REGION and TWILIO_EDGE variables inside the current environment.

Alternatively, you may specify the edge and/or region after constructing the Twilio client:

from twilio.rest import Client

client = Client()
client.region = 'au1'
client.edge = 'sydney'

This will result in the hostname transforming from api.twilio.com to api.sydney.au1.twilio.com.

Make a Call

from twilio.rest import Client

account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
auth_token  = "your_auth_token"
client = Client(account_sid, auth_token)

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

Get data about an existing call

from twilio.rest import Client

account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
auth_token  = "your_auth_token"
client = Client(account_sid, auth_token)

call = client.calls.get("CA42ed11f93dc08b952027ffbc406d0868")
print(call.to)

Iterate through records

The library automatically handles paging for you. Collections, such as calls and messages, have list and stream methods that page under the hood. With both list and stream, you can specify the number of records you want to receive (limit) and the maximum size you want each page fetch to be (page_size). The library will then handle the task for you.

list eagerly fetches all records and returns them as a list, whereas stream returns an iterator and lazily retrieves pages of records as you iterate over the collection. You can also page manually using the page method.

Use the list method

from twilio.rest import Client

account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
auth_token = "your_auth_token"
client = Client(account_sid, auth_token)

for sms in client.messages.list():
  print(sms.to)

Asynchronous API Requests

By default, the Twilio Client will make synchronous requests to the Twilio API. To allow for asynchronous, non-blocking requests, we've included an optional asynchronous HTTP client. When used with the Client and the accompanying *_async methods, requests made to the Twilio API will be performed asynchronously.

from twilio.http.async_http_client import AsyncTwilioHttpClient
from twilio.rest import Client

async def main():
    account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    auth_token  = "your_auth_token"
    http_client = AsyncTwilioHttpClient()
    client = Client(account_sid, auth_token, http_client=http_client)

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

asyncio.run(main())

Enable Debug Logging

Log the API request and response data to the console:

import logging

client = Client(account_sid, auth_token)
logging.basicConfig()
client.http_client.logger.setLevel(logging.INFO)

Log the API request and response data to a file:

import logging

client = Client(account_sid, auth_token)
logging.basicConfig(filename='./log.txt')
client.http_client.logger.setLevel(logging.INFO)

Handling Exceptions

Version 8.x of twilio-python exports an exception class to help you handle exceptions that are specific to Twilio methods. To use it, import TwilioRestException and catch exceptions as follows:

from twilio.rest import Client
from twilio.base.exceptions import TwilioRestException

account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
auth_token  = "your_auth_token"
client = Client(account_sid, auth_token)

try:
  message = client.messages.create(to="+12316851234", from_="+15555555555",
                                   body="Hello there!")
except TwilioRestException as e:
  print(e)

Generating 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>

Other advanced examples

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!

More Repositories

1

twilio-video-app-react

A collaboration application built with the twilio-video.js SDK and React.js
TypeScript
1,808
star
2

stashboard

An open-source status dashboard running on App Engine
Python
1,594
star
3

twilio-php

A PHP library for communicating with the Twilio REST API and generating TwiML.
PHP
1,447
star
4

twilio-ruby

A Ruby gem for communicating with the Twilio API and generating TwiML
Ruby
1,335
star
5

twilio-node

Node.js helper library
TypeScript
1,304
star
6

OpenVBX

OpenVBX is a web-based open source phone system for business.
PHP
699
star
7

twilio-csharp

Twilio C#/.NET Helper Library for .NET Framework 3.5+ and supported .NET Core versions
C#
636
star
8

BankersBox

redis-like wrapper for javascript storage
CoffeeScript
571
star
9

twilio-video.js

Twilio’s Programmable Video JavaScript SDK
JavaScript
569
star
10

video-quickstart-ios

Twilio Video Quickstart for iOS
Swift
458
star
11

twilio-java

A Java library for communicating with the Twilio REST API and generating TwiML.
Java
440
star
12

video-quickstart-js

A quickstart and code samples for Twilio Video JavaScript SDK. https://www.twilio.com/docs/video
JavaScript
390
star
13

shadow

A HTTP debugging proxy that helps you with your continuous deployments
JavaScript
330
star
14

twilio-go

A Go package for communicating with the Twilio API.
Go
278
star
15

twilio-sans-mono

Twilio Sans Mono is a beautiful and extensive open source programming font
Shell
255
star
16

twilio-video-app-ios

A collaboration application built with the Twilio Video iOS SDK
Swift
246
star
17

authy-php

A PHP client for Authy
PHP
245
star
18

twilio-video-app-android

A collaboration application built with the Twilio Video Android SDK
Kotlin
240
star
19

video-quickstart-android

Twilio Video Quickstart for Android
Java
210
star
20

authy-devise

Authy Devise plugin to add Two-Factor Authentication
Ruby
201
star
21

authy-python

Authy API Client for Python
Python
189
star
22

twilio-salesforce

A Salesforce/Force.com library for communicating with the Twilio REST API and generating TwiML. Need help? Post your questions to http://getsatisfaction.com/twilio or email us at [email protected]
Apex
186
star
23

voice-quickstart-android

Quickstart app for the Voice Android SDK
Java
184
star
24

voice-quickstart-ios

Twilio Voice Quickstart for iOS with Swift
Objective-C
179
star
25

twilio-cli

Unleash the power of Twilio from your command prompt
JavaScript
160
star
26

audioswitch

An Android audio management library for real-time communication apps.
Kotlin
159
star
27

authy-ruby

**Deprecated** Ruby library to access the authy API
Ruby
156
star
28

authy-openvpn

Authy Open VPN Two-Factor Authentication
C
152
star
29

gameday

A collection of Twilio SRE's Gameday Templates
140
star
30

twilio-oai

The Twilio OpenAPI Specification
Makefile
122
star
31

TwilioChatJsReactNative

ReactNative app example for Twilio Programmable Chat with working iOS and Android push messages https://www.twilio.com/chat
JavaScript
114
star
32

chessms

Play Chess over SMS!
Erlang
112
star
33

media-streams

Quick start guides for configuring and consuming Twilio Media Streams
Ruby
102
star
34

twilio-conversations-demo-react

Twilio Conversations Demo Web Application
TypeScript
97
star
35

apkscale

A Gradle plugin to measure the app size impact of Android libraries
Kotlin
93
star
36

OpenVBX-iPhone

OpenVBX for iPhone
Objective-C
92
star
37

twilio-chat-demo-js

Programmable Chat API Demo Application for JavaScript
JavaScript
92
star
38

starter-node

A starter app for node.js developers embarking on their first Twilio quest!
JavaScript
84
star
39

authy-form-helpers

Authy javascripts and css file to help create quick forms for the authy api
CoffeeScript
83
star
40

flex-plugin-builder

Packages related to building a Twilio Flex Plugin
TypeScript
83
star
41

starter-python

A starter app for Python developers embarking on their first Twilio quest!
CSS
76
star
42

sourd.io

sourd.io: temperature, humidity, and rise monitoring for your sourdough starter
C++
73
star
43

twilio-voice-react-native

TypeScript
67
star
44

twilio-client.js

Twilio’s Programmable Voice JavaScript SDK
TypeScript
67
star
45

authy-java

Java Client for Twilio Authy Two-Factor Authentication (2FA) API
Java
65
star
46

twilio-video-ios

Programmable Video SDK by Twilio
Swift
64
star
47

twilio-chat-demo-android

Chat API Demo Application for Android
Kotlin
63
star
48

twilio-webchat-react-app

Twilio Webchat React App is an application that demonstrates a website chat widget built with Twilio's Conversations JS SDK, Twilio Paste Design library and Create React App.
TypeScript
63
star
49

terraform-provider-twilio

Terraform Twilio provider
Go
62
star
50

twilio-voice.js

Twilio's JavaScript Voice SDK
TypeScript
50
star
51

twilio-webrtc.js

WebRTC-related APIs and shims used by twilio-video.js
JavaScript
49
star
52

rtc-diagnostics

TypeScript
44
star
53

flex-ui-sample

Twilio Flex UI Sample
JavaScript
44
star
54

twilio-video-diagnostics-react-app

A diagnostics tool that tests a participant's ability to have a quality video call. Built with the twilio-video.js SDK, RTC Diagnostics SDK, and React.js.
TypeScript
41
star
55

wiztowar

Build WARs from your Dropwizard apps
Java
40
star
56

hackathons

A collection of tips and tricks for using Twilio at hackathons
40
star
57

twilio-voice-ios

Programmable Voice SDK by Twilio
Swift
39
star
58

voice-quickstart-objc

Twilio Voice Quickstart for iOS with Objective-C
Objective-C
38
star
59

twilio-voice-notification-app

Reference app built in ReactJS that demonstrates how to leverage Twilio Programmable Voice and Twilio SDKs to create a voice notification system.
TypeScript
36
star
60

sample-code

Auto-generated code samples for the Twilio REST API
Java
35
star
61

draw-with-twilio

Draw with Twilio
JavaScript
35
star
62

video-quickstart-objc

Twilio Video Quickstart for iOS with Objective-C
Objective-C
33
star
63

twilio-video-processors.js

Twilio Video Processors is a collection of video processing tools which can be used with Twilio Video JavaScript SDK to apply transformations and filters to a video track.
TypeScript
33
star
64

twilio-voice-react-native-app

TypeScript
32
star
65

TwilioChatXamarinBindings

Twilio Chat Bindings for Xamarin (Android and iOS) and Sample app with working FCM and APN pushes using those bindings.
C#
32
star
66

flex-webchat-ui-sample

Twilio Flex Web Chat UI Sample
JavaScript
31
star
67

twilio-live-interactive-video

An interactive live video app built with Twilio Live and Twilio Video
TypeScript
31
star
68

twilio-video.js-recording-bot

JavaScript
30
star
69

twilio-chat-demo-ios

Twilio Programmable Chat Demo Application for iOS
Objective-C
28
star
70

calcite-kudu

Apache Calcite Adapter for Apache Kudu
Java
28
star
71

ortc-adapter

ORTC to WebRTC Adapter
JavaScript
28
star
72

cloudsec

27
star
73

starter-ruby

A starter app for Ruby developers embarking on their first Twilio quest!
JavaScript
27
star
74

twilio-oai-generator

Twilio OpenAPI client generator
Java
26
star
75

autopilot-cli

The Twilio Autopilot CLI is now deprecated. Please use the Autopilot Plugin for the Twilio CLI here https://www.twilio.com/docs/autopilot/twilio-autopilot-cli
JavaScript
26
star
76

voice-quickstart-server-python

Python
25
star
77

twilio-taskrouter.js

JS SDK v2 for Twilio's TaskRouter skills based routing system.
JavaScript
24
star
78

twilio-boost-build

Build tool for boost libraries on android, ios, linux and osx
Shell
24
star
79

wireless-security-camera

Create a Twilio-powered device that keeps watch over dangerous and remote locations and alerts stakeholders of intrusions or safety concerns.
CSS
24
star
80

twilio-video-room-monitor.js

A browser-based tool that displays information and metrics about Twilio Video JavaScript applications
TypeScript
24
star
81

video-shared-arkit-sample

ARKit + Twilio Video Data Tracks demo
Swift
24
star
82

voice-quickstart-server-node

voice quickstart server example in node
JavaScript
24
star
83

starter-java

A starter app for Java developers embarking on their first Twilio quest!
CSS
22
star
84

wireless-fleet-tracker

Create a Twilio-powered Fleet Tracker that uses off-the-shelf components to track and log: miles driven, hours of uptime and downtime, locations, average speed, and fuel consumption.
CSS
22
star
85

voices

Twilio Voices - Contribute programming tutorials to the Twilio blog. Get paid for each post you publish.
20
star
86

rtc-diagnostics-react-app

TypeScript
20
star
87

autopilot-templates

JavaScript
19
star
88

client-js-1.4-examples

Examples for using the new Client JS 1.4 Audio functionality
JavaScript
19
star
89

wp-click2call

Wordpress Plugin for Click2Call
PHP
19
star
90

authy.net

.NET Library to access the Authy API
C#
19
star
91

starter-php

A starter app for PHP developers embarking on their first Twilio quest!
PHP
19
star
92

Breakout_Arduino_Library

C
18
star
93

howtos

Sample applications that cover common use cases in a variety of languages.
Python
18
star
94

twilio-conversations-demo-android-kotlin

An application demonstrating use of Twilio Conversations on Android - this is a full working Kotlin application
Kotlin
18
star
95

cerebro

Python
17
star
96

linkit-one-sensor-samples

Samples for the LinkIt ONE Starter Kit
C++
17
star
97

twilio-flex-token-validator

Flex JWE Token Validator
TypeScript
17
star
98

wireless-postman-collection

This repository includes a group of Programmable Wireless HTTP requests for your convenience. You can learn more about Programmable Wireless HTTP request formats in the Programmable Wireless Documentation.
17
star
99

twilio-verify-ios

Twilio Verify Push SDK helps you verify users by adding a low-friction, secure, cost-effective, "push verification" factor into your own apps. This project provides an SDK to implement Verify Push for your iOS app.
Swift
17
star
100

twilio-conversations-demo-ios-swift

Twilio Conversations for iOS Demo application in Swift
Swift
17
star