The default branch name for this repository has been changed to main
as of 07/27/2020.
The documentation for the Twilio API can be found here.
The Ruby library documentation can be found here and individual releases here.
twilio-ruby
uses a modified version of Semantic Versioning for all changes. See this document for details.
This library supports the following Ruby implementations:
- Ruby 2.4
- Ruby 2.5
- Ruby 2.6
- Ruby 2.7
To install using Bundler grab the latest stable version:
gem 'twilio-ruby', '~> 5.47.0'
To manually install twilio-ruby
via Rubygems simply gem install:
gem install twilio-ruby -v 5.47.0
To build and install the development branch yourself from the latest source:
git clone [email protected]:twilio/twilio-ruby.git
cd twilio-ruby
make install
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
require 'twilio-ruby'
# put your own credentials here
account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
api_key_sid = 'zzzzzzzzzzzzzzzzzzzzzz'
api_key_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
# set up a client to talk to the Twilio REST API using an API Key
@client = Twilio::REST::Client.new api_key_sid, api_key_secret, account_sid
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'
In order to enable debug logging, pass in a 'logger' instance to the client with the level set to at least 'DEBUG'
@client = Twilio::REST::Client.new account_sid, auth_token
myLogger = Logger.new(STDOUT)
myLogger.level = Logger::DEBUG
@client.logger = myLogger
@client = Twilio::REST::Client.new account_sid, auth_token
myLogger = Logger.new('my_log.log')
myLogger.level = Logger::DEBUG
@client.logger = myLogger
This will result in the hostname
transforming from api.twilio.com
to api.sydney.au1.twilio.com
.
@client.calls.create(
from: '+14159341234',
to: '+16105557069',
url: 'http://example.com'
)
@client.messages.create(
from: '+14159341234',
to: '+16105557069',
body: 'Hey there!'
)
@client.messages.list(limit: 20)
# put the message sid you want to retrieve here:
message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
@client.messages(message_sid).fetch
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
To use a custom HTTP client with this helper library, please see the Twilio documentation.
begin
messages = @client.messages.list(limit: 20)
rescue Twilio::REST::RestError => e
puts e.message
end
For more descriptive exception types, please see the Twilio documentation.
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.
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>
The Dockerfile
present in this repository and its respective twilio/twilio-ruby
Docker image are currently used by Twilio for testing purposes only.
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!