Twilio Python Helper Library

https://www.twilio.com/docs/libraries/reference/twilio-python/
Admin
The Twilio Python Helper Library provides a convenient way for Python developers to interact with...
Tokens:2,637
Snippets:17
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Twilio Python Library

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

Installs the Twilio Python helper library using pip, the Python package manager. It also provides alternative installation methods and troubleshooting tips for Windows.

```bash
pip3 install twilio
```

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

```bash
python3 setup.py install
```

--------------------------------

### TwiML Output Example

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This shows the XML output generated for a TwiML response, specifically for a voice response that says 'Welcome to twilio!'. This is the format Twilio expects to control call behavior.

```XML
<?xml version="1.0" encoding="utf-8"?>
<Response><Say>Welcome to twilio!</Say></Response>
```

--------------------------------

### Fetch Messages with Specific Page Size and Limit

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This example shows how to fetch messages with a specific page size and limit. It demonstrates how `page_size` and `limit` affect the number of API calls and records returned.

```Python
client.messages.list(limit=20, page_size=20)
```

```Python
client.messages.list(limit=20, page_size=10)
```

```Python
client.messages.list(limit=20, page_size=100)
```

--------------------------------

### Get Data for an Existing Call

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet shows how to retrieve details about a specific existing call using its unique SID. It then prints the 'to' number associated with that call.

```Python
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)
```

--------------------------------

### Handle TwilioRestException

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This example illustrates how to handle exceptions specific to Twilio API calls using the `TwilioRestException` class. It involves importing the exception, making a Twilio API call within a try-except block, and printing the exception details.

```Python
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)
```

--------------------------------

### Authenticate with API Key and API Secret

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet demonstrates authentication using an API Key and API Secret, along with the Account SID. These are alternative credentials for accessing the Twilio API.

```Python
from twilio.rest import Client

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

--------------------------------

### Authenticate using Environment Variables

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet shows how to authenticate by allowing the Twilio Client to automatically pick up credentials from environment variables TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN.

```Python
from twilio.rest import Client
client = Client()
```

--------------------------------

### Authenticate with Account SID and Auth Token

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet shows how to authenticate the Twilio client using your Account SID and Auth Token. These credentials can be passed directly to the Client constructor.

```Python
from twilio.rest import Client

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

--------------------------------

### Asynchronous API Request with AsyncTwilioHttpClient

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet shows how to perform asynchronous API requests using the `AsyncTwilioHttpClient`. It demonstrates creating a message asynchronously and requires the `asyncio` library.

```Python
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())
```

--------------------------------

### Specify Region and Edge for Client

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet illustrates how to specify a target Region and Edge for the Twilio client to leverage Twilio's Global Infrastructure. Both parameters must be provided together.

```Python
from twilio.rest import Client

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

--------------------------------

### Send SMS with Twilio Python Library

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

Demonstrates how to send an SMS message using the Twilio Python helper library. It requires your Twilio Account SID, Auth Token, and valid phone numbers. The code initializes the Twilio client and creates a message object.

```python
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)
```

--------------------------------

### Set Region and Edge After Client Initialization

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet shows how to set the region and edge after the Twilio client has already been initialized. This will change the API hostname accordingly.

```Python
from twilio.rest import Client

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

--------------------------------

### Enable Debug Logging to File

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet shows how to configure the Twilio Python library to log API request and response data to a specified file. It involves setting up basic logging with a filename and then setting the client's HTTP client logger level.

```Python
import logging

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

--------------------------------

### Make an Outbound Call

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet demonstrates how to make an outbound call using the Twilio Python library. It requires the recipient's number, the Twilio number, and a URL for call instructions.

```Python
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)
```

--------------------------------

### Enable Debug Logging to Console

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet demonstrates how to enable debug logging for the Twilio Python library to output API request and response data to the console. It requires the `twilio` library and sets the logger level to INFO.

```Python
import logging

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

--------------------------------

### Generate TwiML Response

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet demonstrates how to generate TwiML (Twilio Markup Language) for controlling phone calls using the `twilio-python` library. It utilizes the `VoiceResponse` class to construct TwiML, which is then printed as a string.

```Python
from twilio.twiml.voice_response import VoiceResponse

r = VoiceResponse()
r.say("Welcome to twilio!")
print(str(r))
```

--------------------------------

### Iterate Through Messages using list()

Source: https://www.twilio.com/docs/libraries/reference/twilio-python/index

This snippet demonstrates how to iterate through a list of messages using the `list()` method. It fetches all messages and prints the 'to' number for each.

```Python
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)
```
Tokens:
Raw