Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Twilio Connect Ruby Quickstart



Overview

overview page anchor

Twilio Connect is an easy way for 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.


Creating Your First Twilio Connect App

creating-your-first-twilio-connect-app page anchor

Let's jump right in and create our first Connect app. Log in to your Twilio account dashboard, select "Apps" and click the "Create Connect App" button. 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:

Rossum Twilio Connect App.

Click 'Save Changes' and you're done!


Placing the Connect Button on Your Website

placing-the-connect-button-on-your-website page anchor
Twilio Connect.

The Connect button is where your customers will start the process of authorizing your Connect App to access their Twilio account. You can generate the code needed to place this button on your website with the Twilio Connect button HTML generator.

After saving your application you will see a popup with HTML code. Copy the generated code and paste it into the HTML of your website where you would like the button to appear. If you ever need to generate this HTML again, click on the "Generate Connect Button HTML" link at the bottom of your Connect App Details page.


Testing the Authorization Workflow

testing-the-authorization-workflow page anchor

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:


_10
http://www.example.com/twilio/authorize?AccountSid=AC12345
_10
Your Connect App's Authorize URL Customer's SID

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 Ruby.

(warning)

Warning

This tutorial assumes you have a Ruby development environment with Sinatra and the twilio-ruby helper library. If you don't have these yet, please see our post on setting up your Ruby environment.


_13
require 'rubygems'
_13
require 'sinatra'
_13
require 'twilio-ruby'
_13
_13
get '/connect' do
_13
sid = params['AccountSid']
_13
# Store this account sid in your database, so you can retrieve it
_13
# later. You will need to write this section of the code.
_13
_13
# Finally, redirect the user to your app after you've gathered their Sid
_13
redirect 'http://example.com/myapp'
_13
_13
end


Making an Authorized Request

making-an-authorized-request page anchor

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 simple request to retrieve call logs from an account using the Ruby helper library. Pay special attention to line 4 where the customer's Account Sid is specified instead of your own:


_20
require 'rubygems' # not necessary with ruby 1.9 but included for completeness
_20
require 'twilio-ruby'
_20
_20
# Use your customer's account sid.
_20
account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
_20
_20
# Use your own auth token.
_20
auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
_20
_20
# set up a client to talk to the Twilio REST API
_20
client = Twilio::REST::Client.new(account_sid, auth_token)
_20
_20
calls = client.calls.list
_20
_20
begin
_20
calls.each do |call|
_20
puts call.sid + "\t" + call.from + "\t" + call.to
_20
end
_20
calls = calls.next_page
_20
end while not calls.empty?


You're Done! Now What?

youre-done-now-what page anchor

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.


Rate this Page: