Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Programmable Messaging Quickstart - Ruby


(information)

Info

Ahoy there! All messaging transmitted using Twilio's messaging channels is treated as Application-to-Person (A2P) messaging and subject to Twilio's Messaging Policy(link takes you to an external page). For detailed information on policy rules to ensure you remain compliant while using Twilio's services, please see our Acceptable Use Policy(link takes you to an external page).

With just a few lines of code, your Ruby application can send and receive text messages with Twilio Programmable Messaging.

This Ruby Quickstart will teach you how to do this using our Programmable Messaging REST API, the Twilio Ruby helper library, and Ruby's Sinatra framework(link takes you to an external page) to ease development. If you prefer using Rails, check out this blog post(link takes you to an external page).

In this Quickstart, you will learn how to:

  1. Sign up for Twilio and get your first SMS-enabled Twilio phone number
  2. Set up your development environment to send and receive messages
  3. Send your first SMS
  4. Receive inbound text messages
  5. Reply to incoming messages with an SMS

Prefer to get started by watching a video? Check out our Ruby SMS Quickstart video on Youtube(link takes you to an external page).


Sign up for Twilio and Get a Twilio Phone Number

sign-up-for-twilio-and-get-a-twilio-phone-number page anchor
(information)

Info

If you already have a Twilio account and an SMS-enabled Twilio phone number, you're all set here! Feel free to jump to the next step.

(warning)

Warning

If you are sending SMS to the U.S. or Canada, before proceeding further please be aware of updated restrictions on the use of Toll-Free numbers for messaging, including TF numbers obtained through Free Trial. Please click here(link takes you to an external page) for details.

You can sign up for a free Twilio trial account here(link takes you to an external page).

  • When you sign up, you'll be asked to verify your personal phone number. This helps Twilio verify your identity and also allows you to send test messages to your phone from your Twilio account while in trial mode.
  • Once you verify your number, you'll be asked a series of questions to customize your experience.
  • Once you finish the onboarding flow, you'll arrive at your project dashboard in the Twilio Console(link takes you to an external page) . This is where you'll be able to access your Account SID, authentication token, find a Twilio phone number, and more.

If you don't currently own a Twilio phone number with SMS functionality, you'll need to purchase one. After navigating to the Buy a Number(link takes you to an external page) page, check the SMS box and click Search.

Buy a twilio phone number.

You'll then see a list of available phone numbers and their capabilities. Find a number that suits your fancy and click Buy to add it to your account.

Select an SMS-enabled phone number.

We'll need to use the Twilio CLI (command line interface) for a few tasks, so let's install that next.

macOSWindowsLinux

The suggested way to install twilio-cli on macOS is to use Homebrew(link takes you to an external page). If you don't already have it installed, visit the Homebrew site(link takes you to an external page) for installation instructions and then return here.

Once you have installed Homebrew, run the following command to install twilio-cli:


_10
brew tap twilio/brew && brew install twilio

(information)

Info

For other installation methods, see the Twilio CLI Quickstart.

Log in to the Twilio CLI

log-in-to-the-twilio-cli page anchor

Run twilio login to get the Twilio CLI connected to your account. Visit the Twilio Console(link takes you to an external page), and under Account Info, you'll find your unique Account SID and Auth Token to provide to the CLI.

Next, we need to install Ruby and the Twilio Ruby Helper Library.


Install Ruby and the Twilio Helper Library

install-ruby-and-the-twilio-helper-library page anchor
(information)

Info

If you've gone through one of our other Ruby Quickstarts already and have Ruby and the Twilio Ruby helper library installed, you can skip this step and get straight to sending your first text message.

To send your first SMS, you'll need to have Ruby and the Twilio Ruby helper library installed.

Install Ruby

install-ruby page anchor

If you're using a Mac or Linux machine, you probably already have Ruby installed. You can check this by opening up a terminal and running the following command:

$ ruby --version

You should see something like:

ruby 2.7.2

Windows users can use RubyInstaller(link takes you to an external page) to install Ruby.

Twilio's Ruby SDK is tested against and supports Ruby versions from 2.4 through 3.0. (Got an older version of Ruby? You can use rbenv(link takes you to an external page), RVM(link takes you to an external page) or Homebrew(link takes you to an external page) to upgrade to the minimum supported version.)

Install the Twilio Ruby Helper Library

install-the-twilio-ruby-helper-library page anchor

The easiest way to install twilio-ruby is from RubyGems.


_10
gem install twilio-ruby

Manual Installation

Or, you can clone the source code(link takes you to an external page) for twilio-ruby, and install the library from there.

"Permission Denied"

If the command line gives you a long error message that says Permission Denied in the middle of it, try running the above commands with sudo:


_10
sudo gem install twilio-ruby


Send an outbound SMS with Ruby

send-an-outbound-sms-with-ruby page anchor

Now that we have Ruby and twilio-ruby installed, we can send an outbound text message from the Twilio phone number we just purchased with a single API request. Create and open a new file called send_sms.rb and type or paste in this code sample.

This code creates a new instance of the Message resource and sends an HTTP POST to the Messages resource URI.


_16
# Download the twilio-ruby library from twilio.com/docs/libraries/ruby
_16
require 'twilio-ruby'
_16
_16
# To set up environmental variables, see http://twil.io/secure
_16
account_sid = ENV['TWILIO_ACCOUNT_SID']
_16
auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyy'
_16
client = Twilio::REST::Client.new(account_sid, auth_token)
_16
_16
from = '+15551234567' # Your Twilio number
_16
to = '+15555555555' # Your mobile phone number
_16
_16
client.messages.create(
_16
from: from,
_16
to: to,
_16
body: "Hey friend!"
_16
)

You'll need to edit this file a little more before your message will send.

Replace the placeholder credential values

replace-the-placeholder-credential-values page anchor
  1. Go to the Twilio Console(link takes you to an external page) and find your unique Account SID and Auth Token.
  2. Open send_sms.rb and replace the values for account_sid and auth_token with your Account SID and Auth Token.
(error)

Danger

Please note: it's okay to hardcode your credentials when getting started, but you should use environment variables to keep them secret before deploying to production. Check out how to set environment variables(link takes you to an external page) for more information.

Replace the from phone number

replace-the-from-phone-number page anchor

Remember that SMS-enabled phone number you bought just a few minutes ago? Go ahead and replace the existing from number with that one, making sure to use E.164 formatting:

[+][country code][phone number including area code]

Replace the to phone number

replace-the-to-phone-number page anchor

Replace the to phone number with your mobile phone number. This can be any phone number that can receive text messages, but it's a good idea to test with your own phone to see the magic happen! As above, you should use E.164 formatting for this value.Save your changes and run this script from your terminal:

ruby send_sms.rb

That's it! In a few moments, you should receive an SMS from your Twilio number on your phone.

(information)

Info

Are your customers in the U.S. or Canada? You can also send them MMS messages by adding just one line of code. Check out this guide to sending MMS to see how it's done.

(warning)

Warning

If you are on a Twilio trial account, your outgoing SMS messages are limited to phone numbers that you have verified with Twilio. Phone numbers can be verified via your Twilio Console's Verified Caller IDs(link takes you to an external page).


Install Sinatra and set up your development environment

install-sinatra-and-set-up-your-development-environment page anchor

In order to receive and reply to incoming SMS messages, we'll need to create a very lightweight web application that can accept incoming requests. We'll use Sinatra(link takes you to an external page) for this Quickstart, but if you prefer to use Rails, you can find instructions in this blog post(link takes you to an external page).

First, you need a Gemfile with the following content on it. Create a file named Gemfile and paste the following into it:


_10
# Gemfile
_10
source 'https://rubygems.org'
_10
_10
gem 'sinatra'
_10
gem 'twilio-ruby'

Ruby projects use Bundler(link takes you to an external page) to manage dependencies, so the command to pull Sinatra and the Twilio SDK into our development environment is bundle install.


_10
bundle install
_10
_10
Use `bundle show [gemname]` to see where a bundled gem is installed.

Create a simple Sinatra application

create-a-simple-sinatra-application page anchor

We can test that our development environment is configured correctly by creating a simple Sinatra application. Copy the following code and drop it in a new file called quickstart.rb:


_10
require 'sinatra'
_10
_10
get '/' do
_10
"Hello World!"
_10
end

We can then try running our new Sinatra application with the command ruby quickstart.rb. You can then open http://localhost:4567(link takes you to an external page) in your browser and you should see a "Hello World!" message.


Receive and reply to inbound SMS messages with Sinatra

receive-and-reply-to-inbound-sms-messages-with-sinatra page anchor

When someone sends an SMS to your Twilio phone number, Twilio makes an HTTP request to your server asking for instructions on what to do next. Once you receive the request, you can tell Twilio to reply with an SMS, kick off a phone call, store details about the SMS in your database, or trigger something else entirely - it's all up to you!

For this quickstart, we'll have our Sinatra app reply to incoming SMS messages with a thank you to the sender. Open up quickstart.rb again and update the code to look like this code sample:

When your phone number receives an incoming message, Twilio will send an HTTP request to your server. This code shows how your server should respond to reply with a text message.

Ruby

_11
# Download the twilio-ruby library from twilio.com/docs/libraries/ruby
_11
require 'twilio-ruby'
_11
require 'sinatra'
_11
_11
post '/sms-quickstart' do
_11
twiml = Twilio::TwiML::MessagingResponse.new do |r|
_11
r.message(body: 'Ahoy! Thanks so much for your message.')
_11
end
_11
_11
twiml.to_s
_11
end

Output

_10
<?xml version="1.0" encoding="UTF-8"?>
_10
<Response>
_10
<Message>
_10
Ahoy! Thanks so much for your message.
_10
</Message>
_10
</Response>

Save the file and restart your app with:


_10
ruby quickstart.rb

Now Twilio will be able to find your application - but first, we need to tell Twilio where to look. We will use ngrok(link takes you to an external page) to do this.

Configure ngrok and your webhook URL

configure-ngrok-and-your-webhook-url page anchor

We'll use ngrok to set up a tunnel from the public internet to your localhost. This will let us use a public URL as the webhook for your application.

First, download and configure ngrok(link takes you to an external page).

Next, run this command to have ngrok set up a tunnel to your localhost:


_10
ngrok http 4567

This will start an ngrok tunnel. Copy down the Forwarding URL that ends with ngrok.io.

Then, you need to configure your Twilio phone number to call your webhook URL whenever a new message comes in:

  1. Go to Phone Numbers > Active Numbers in the Twilio Console(link takes you to an external page) .
  2. Select the SMS-enabled Twilio number you want to use.
  3. For the A MESSAGE COMES IN webhook, enter the ngrok URL you copied down earlier. Append /sms-quickstart to the end of the URL.
screenshot of 'a message comes in' configuration with ngrok URL.

Test your application with a text

test-your-application-with-a-text page anchor

Now that everything is glued together, it's time to test.

Send a text message from your mobile phone to your Twilio phone number. You'll see a couple of things happen very quickly:

  1. Your Sinatra dev server will note a new connection
  2. Twilio will forward your response back as an SMS!

Now that you know the basics of sending and receiving SMS text messages with Ruby and Sinatra, you might want to check out these resources.

We can't wait to see what you build!


Rate this page: