Twilio Connect allows developers to obtain authorization to make
calls, send text messages, purchase phone numbers, read access logs and perform
other API functions on behalf of another Twilio account holder.
As an example, imagine you want to access the Twilio account of a user of
your web application to provide in-depth analytics of their Twilio account
activity. In this quickstart we'll solve this problem by creating your first
Twilio Connect App, placing the "Connect" button on your website so users can
authorize your app to access their Twilio account data and make API requests
against their account.
Create your first Twilio Connect app
To create your first Connect App, log in to the Twilio Console and go to Settings > Connect applications. Click Create a new connect app and fill in the top section with the name of your application and your company information.
Next, assign an Authorize URL to your Connect application. The Authorize
URL is the URL that Twilio will redirect the user's browser to after they have
authorized your application to access their Twilio account. Later on in the
quickstart we'll demonstrate how the Authorize URL is used.
Lastly, select the access rights your Connect app requires on the user's
account. For this example we will access call logs for analytics, so
we'll choose "Read all account data".
Here's what our sample Connect application looks like:
Click Save and you're done!
Place the Connect button on your website
The Connect button is where your customers will start the process of
authorizing your Connect App to access their Twilio account.
To get the Connect button code, click Generate connect button HTML on your
Connect App details page. Copy the generated code and paste it into the HTML
of your website where you would like the button to appear.
Test the Authorization workflow
With the Twilio Connect button now on your website, browse to the page
where you placed the HTML and click the Connect button. Verify that the
information displayed on the authorization screen is correct.
After completing the app authorization process, you are redirected to the
Authorize URL you specified when creating your Connect App. Appended to that
URL is an Account Sid URL parameter with a value that looks like this:
Your application should extract the AccountSid value from the URL and
associate it with the user's account within your application. After extracting
the AccountSid, we recommend that you redirect the user to another page within
your app so the AccountSid isn't hanging around. Let's show an example using
Python.
# the account sid in your database, so you can find it later.
9
10
# Finally redirect
11
returnredirect('http://example.com/myapp')
12
13
if__name__=="__main__":
14
app.run(debug=True)
Make an authorized request
With the user's Account Sid in hand you can now request data from their
account via the Twilio REST API. A request to retrieve data from a user's
account is nearly identical to a request made against your own account, with
one key difference. Instead of authenticating with your own AccountSid, you
authenticate with the Account Sid retrieved during the authorization process
and your account's Auth Token.
Here is a request to retrieve call logs from an account using the
Python SDK. Pay special attention to line 4 where the customer's Account Sid is specified instead of your own:
1
fromtwilio.restimportClient
2
3
# The customer's AccountSid
4
account="ACXXXXXXXXXXXXXXXXX"
5
6
# Your own AuthToken
7
token="YYYYYYYYYYYYYYYYYY"
8
9
client=Client(account, token)
10
11
# Request the call logs for the customer's account, and print them.
Retrieving call logs on behalf of your customers is just the
start of what you can accomplish with Twilio Connect. Visit
the complete Connect documentation and best
practices to learn more about how to integrate
Connect's additional capabilities into your applications.