Skip to content
A Ruby gem for communicating with the Twilio API and generating TwiML
Ruby
Branch: master
Clone or download

Latest commit

Latest commit 59e0ee5 May 30, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
conf use an included ca cert bundle for convenience Jan 6, 2012
examples Fixed example code (#384) Feb 24, 2018
githooks chore: clean up and upgrade dev dependencies (#497) Mar 2, 2020
lib Release 5.36.0 May 27, 2020
spec [Librarian] Regenerated @ e9f89292df2f5937d5655a62b819834e82cacac8 May 27, 2020
.dockerignore Fix the Dockerfile to use the latest Ruby 2.4 and ignore the Gem lock… Sep 19, 2019
.gitignore added request validation for urls with and without ports (#481) Oct 24, 2019
.rubocop.yml feat: add details to error object (#511) Apr 29, 2020
.rubocop_todo.yml chore: bump the rubocop version Apr 29, 2020
.travis.yml chore: Travis: Drop unused "sudo: false" directive (#507) Apr 7, 2020
AUTHORS.md Bumping to version 5.0.0.rc17 Sep 15, 2016
CHANGES.md [Librarian] Regenerated @ e9f89292df2f5937d5655a62b819834e82cacac8 May 27, 2020
CODE_OF_CONDUCT.md docs: baseline all the templated markdown docs (#492) Jan 17, 2020
CONTRIBUTING.md [Librarian] Regenerated @ e1fdbad79f0a5b5c68afaf6798362f18827b32d1 Oct 2, 2019
Dockerfile Fix the Dockerfile to use the latest Ruby 2.4 and ignore the Gem lock… Sep 19, 2019
Gemfile chore: clean up and upgrade dev dependencies (#497) Mar 2, 2020
ISSUE_TEMPLATE.md docs: baseline all the templated markdown docs (#492) Jan 17, 2020
LICENSE.md docs: baseline all the templated markdown docs (#492) Jan 17, 2020
Makefile chore: clean up and upgrade dev dependencies (#497) Mar 2, 2020
PULL_REQUEST_TEMPLATE.md docs: baseline all the templated markdown docs (#492) Jan 17, 2020
README.md Update README.md May 29, 2020
Rakefile chore: clean up and upgrade dev dependencies (#497) Mar 2, 2020
UPGRADE.md Add changelog and upgrade for 5.3.0 Sep 29, 2017
VERSIONS.md [Librarian] Regenerated @ 36666be96315587760af943d4fe939d892f128d7 Sep 18, 2019
twilio-ruby.gemspec fix: remove tabs from gemspec Apr 29, 2020

README.md

twilio-ruby

Build Status Gem Version Learn with TwilioQuest

Documentation

The documentation for the Twilio API can be found here.

The Ruby library documentation can be found here and individual releases here.

Versions

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

Supported Ruby Versions

This library supports the following Ruby implementations:

  • Ruby 2.4
  • Ruby 2.5
  • Ruby 2.6
  • Ruby 2.7

Migrating from 4.x

Upgrade Guide

Installation

To install using Bundler grab the latest stable version:

gem 'twilio-ruby', '~> 5.36.0'

To manually install twilio-ruby via Rubygems simply gem install:

gem install twilio-ruby -v 5.36.0

To build and install the development branch yourself from the latest source:

git clone git@github.com:twilio/twilio-ruby.git
cd twilio-ruby
make install

Getting Started

Setup Work

require 'twilio-ruby'

# put your own credentials here
account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'

# set up a client to talk to the Twilio REST API
@client = Twilio::REST::Client.new account_sid, auth_token

Specify a Region and/or Edge

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

# set up a client to talk to the Twilio REST API over a specific region and edge
@client = Twilio::REST::Client.new account_sid, auth_token, nil, 'au1'
@client.edge = 'sydney'

# you may also specify the region and/or edge after client creation
@client = Twilio::REST::Client.new account_sid, auth_token
@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

@client.calls.create(
  from: '+14159341234',
  to: '+16105557069',
  url: 'http://example.com'
)

Send an SMS

@client.messages.create(
  from: '+14159341234',
  to: '+16105557069',
  body: 'Hey there!'
)

List your SMS Messages

@client.messages.list(limit: 20)

Fetch a single SMS message by Sid

# put the message sid you want to retrieve here:
message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
@client.messages(message_sid).fetch

Customizing your HTTP Client

twilio-ruby uses Faraday to make HTTP requests. You can tell Twilio::REST::Client to use any of the Faraday adapters like so:

@client.http_client.adapter = :typhoeus

Handling Errors

begin
  messages = @client.messages.list(limit: 20)
rescue Twilio::REST::TwilioError => e
  puts e.message
end

Getting Started With Client Capability Tokens

If you just need to generate a Capability Token for use with Twilio Client, you can do this:

require 'twilio-ruby'

# put your own account credentials here:
account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'

# set up
capability = Twilio::JWT::ClientCapability.new account_sid, auth_token

# allow outgoing calls to an application
outgoing_scope = Twilio::JWT::ClientCapability::OutgoingClientScope.new 'AP11111111111111111111111111111111'
capability.add_scope(outgoing_scope)

# allow incoming calls to 'andrew'
incoming_scope = Twilio::JWT::ClientCapability::IncomingClientScope.new 'andrew'
capability.add_scope(incoming_scope)

# generate the token string
@token = capability.to_s

There is a slightly more detailed document in the Capability section of the wiki.

Generating TwiML

To control phone calls, your application needs to output TwiML.

You can construct a TwiML response like this:

require 'twilio-ruby'

response = Twilio::TwiML::VoiceResponse.new do |r|
  r.say(message: 'hello there', voice: 'alice')
  r.dial(caller_id: '+14159992222') do |d|
    d.client 'jenny'
  end
end

# print the result
puts response.to_s

This will print the following (except for the whitespace):

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Say voice="alice">hello there</Say>
  <Dial callerId="+14159992222">
    <Client>jenny</Client>
  </Dial>
</Response>

Docker Image

The Dockerfile present in this repository and its respective twilio/twilio-ruby 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!

You can’t perform that action at this time.