Skip to main content
  • Ruby Sinatra
  • Ruby Rails

​
Get Started with Ruby Using Sinatra Framework

Start by signing up for a free trial account that you can use to experiment with and learn about our services. The free trial account comes with free credits, and you can add more as you go along. You can also add a phone number to your account to start testing the full range of our voice and SMS features. A page in our support portal walks you through the signup process.You can start making and receiving calls either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.
  • Using XML

​
Install Ruby, Sinatra, and the Plivo Ruby SDK

You must set up and install Ruby, Sinatra, and Plivo’s Ruby SDK before you make your first call.

​
Install Ruby

Download and install Ruby from its official site.

​
Install Sinatra

$ gem install sinatra

​
Install the Plivo Ruby SDK

Create a projects directory and change into it.
$ mkdir myrubyapp
$ cd myrubyapp
Edit the Gemfile and add this line.
gem 'plivo', '~> 4.24.0'
Then install the Plivo Ruby gem into the bundle.
$ bundle install
Or install it yourself.
$ gem install plivo
Once you’ve set up your development environment, you can start making and receiving calls using our APIs and XML documents. Here are three common use cases to get you started.

​
Make your first outbound call

Plivo requests an answer URL when the call is answered (step 4) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. To see how this works, you can use https://s3.amazonaws.com/static.plivo.com/answer.xml as an answer URL to test your first outgoing call. The file contains this XML code:
<Response>
<Speak>Congratulations! You've made your first outbound call!</Speak>
</Response>
This code instructs Plivo to say, “Congratulations! You’ve made your first outbound call!” to the call recipient. You can find the entire list of valid Plivo XML verbs in our XML Reference documentation.

​
Set up a Sinatra server to handle outbound calls

Create a file called Makecall.rb and paste into it this code.
require 'rubygems'
require 'plivo'

include Plivo
include Plivo::Exceptions

api = RestClient.new("<auth_id>","<auth_token>")

begin
  response = api.calls.create(
    '<caller_id>',
    ['<destination_number>'],
    'https://s3.amazonaws.com/static.plivo.com/answer.xml'
  )
  puts response
rescue PlivoRESTError => e
  puts 'Exception: ' + e.message
end
Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).
Note: We recommend that you store your credentials in the auth_id and auth_token environment variables to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use ENV to store environment variables and retrieve them when initializing the client.

​
Test

Save the file and run it.
$ ruby Makecall.rb

​
Receive your first inbound call

Plivo requests an answer URL when it answers the call (step 2) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. In this example, when an incoming call is received, Plivo’s text-to-speech engine plays a message using the Speak XML element.You must have a voice-enabled Plivo phone number to receive incoming calls; you can rent numbers from the Numbers page of the Plivo console, or by using the Numbers API.

​
Set up a Sinatra server to handle incoming calls

Create a file called receive_call.rb and paste into it this code.
require "sinatra"
require 'plivo'

include Plivo::XML

get "/receive_call/" do
  response = Response.new
  speak_body = 'Hello, you just received your first call'
  response.addSpeak(speak_body)
  xml = PlivoXML.new(response)

  content_type "application/xml"
  return xml.to_s()
end
Save the file and run it.
$ ruby receive_call.rb
You should see your basic server application in action at http://localhost:4567/receive_call/.

​
Expose your local server to the internet

To receive incoming calls, your local server must connect with Plivo API services. For that, we recommend using ngrok, which exposes local servers running behind NATs and firewalls to the public internet over secure tunnels. Using ngrok, you can set webhooks that can talk to the Plivo server.
Run ngrok on the command line, specifying the port that hosts the application on which you want to receive calls (80 in this case):
$ ./ngrok http 80
This starts the ngrok server on your local server. Ngrok will display a forwarding link that you can use as a webhook to access your local server over the public network.

​
Create a Plivo application to receive calls

Associate the Rails application you created with Plivo by creating a Plivo application. Visit Voice > Applications and click Add New Application. You can also use Plivo’s Application API.Give your application a name — we called ours Receive_call. Enter the server URL you want to use (for example https://<yourdomain>.com/receive_call/) in the Primary Answer URL field and set the method to POST. Click Create Application to save your application.

​
Assign a Plivo number to your application

Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Receive_call (the name we gave the application).Click Update Number to save.

​
Test

Make a call to your Plivo number using any phone.

​
Forward an incoming call

Plivo requests an answer URL when the call is answered (step 4) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. In this example, when an incoming call is received, Plivo forwards the call using the Dial XML element.You must have a voice-enabled Plivo phone number to receive incoming calls; you can rent numbers from the Numbers page of the Plivo console, or by using the Numbers API.

​
Set up a Sinatra server to forward calls

Create a file called forward_call.rb and paste into it this code.
require 'rubygems'
require 'plivo'

include Plivo::XML
include Plivo::Exceptions

begin
  response = Response.new
  dial = response.addDial()
  dial.addNumber("<destination_number>")
  xml = PlivoXML.new(response)

  content_type "application/xml"
  return xml.to_s()
end
Replace the destination number placeholder with an actual phone number (for example, 12025551234).If you haven’t done so already, expose your local server to the internet.

​
Create a Plivo application to forward calls

Associate the Ruby application you created with Plivo by creating a Plivo application. Visit Voice > Applications in the Plivo console and click on Add New Application, or use Plivo’s Application API.Give your application a name — we called ours Forward Call. Enter the server URL you want to use (for example https://<yourdomain>.com/forward_call/) in the Answer URL field and set the method to POST. Click Create Application to save your application.

​
Assign a Plivo number to your application

Navigate to the Numbers page and select the phone number you want to use for this application.From the Application Type drop-down, select XML Application.From the Plivo Application drop-down, select Forward Call (the name we gave the application).Click Update Number to save.

​
Test

Make a call to your Plivo number using any phone. Plivo will send a request to the answer URL you provided requesting an XML response and then forward the call according to the instructions in the XML document the server provides.

​
More use cases

We illustrate more than 20 use cases with code for both API/XML and PHLO on our documentation pages.