Get Started with Ruby using Sinatra Framework
Sign up for a Plivo Account
When you sign up with Plivo, you will start with a free trial account to experiment with and learn about our services. This free trial account comes with free credits. If you wish to continue with our service, you can add more credits and purchase a number by clicking here. Add a number and credits to your account to start testing the full range of our voice and SMS service features.
Sign up here to get your free Plivo account today.
Follow these steps to successfully sign up for a free trial account:
- Sign up with your work email address
- Check your inbox for an activation email from Plivo. Click on the link in the email to activate your account.
- Enter your mobile number to complete the phone verification step.
Sign up with your work email address
If you have any issues creating a Plivo account, please reach out to our Support Team for assistance.
Install Ruby and the Plivo Ruby Server SDK
You must set up and install Ruby and Plivo’s Ruby SDK to make your first call. Here’s how.
|OS X & Linux||You would already have Ruby installed, you can check this by running the command ruby --version in the terminal. If you don't have it installed, you can install it using homebrew.|
|Windows||To install Ruby on Windows you can download it from here and install.|
Install Plivo Ruby Package
Create a project directory, run the following command:
$ mkdir myrubyapp
Change the directory to our project directory in the command line:
$ cd myrubyapp
Add this line to your application’s Gemfile:
gem 'plivo', '>= 4.3.0'
And then execute:
Or install it yourself as:
$ gem install plivo
For features in beta, use the beta branch:
$ gem install plivo --pre
Make your first Outbound Call
This section will guide you through how to use Plivo APIs to make voice calls from your application. First, let’s make sure you meet these prerequisites before we dive into the code.
Plivo Phone Number(Optional): You can purchase numbers from the Numbers section of your Plivo Console and use the same as the caller ID for the outbound call. This number will also help you receive incoming calls as you must have a voice-enabled Plivo phone number to do the same. Please note that you can also purchase numbers using the Numbers API.
Answer Url: When a call is answered by the destination_number, you can control the call flow with the help of the answer_url set in the API request. Plivo will invoke the answer_url specified as soon as the call is answered and expect a valid XML response with instructions to handle the call. For example, you can use https://s3.amazonaws.com/static.plivo.com/answer.xml as answer_url to test your first outgoing call. The XML response of this is:
<Response> <Speak>Congratulations! You've made your first outbound call!</Speak> </Response>
As you can tell, the XML above holds instructions to say ‘Congratulations! You’ve made your first outbound call!’ to the callee. You can find the entire list of Plivo XML verbs and their details in the XML Reference section of the website here.
Now, create a file called
Makecall.rb and paste the below code.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 require 'rubygems' require 'plivo' include Plivo include Plivo::Exceptions api = RestClient.new("YOUR_AUTH_ID", "YOUR_AUTH_TOKEN") begin response = api.calls.create( 'the_callerID', ['the_destination_number'], 'http://s3.amazonaws.com/static.plivo.com/answer.xml' ) puts response rescue PlivoRESTError => e puts 'Exception: ' + e.message end
- Replace the placeholders auth_id & auth_token with your credentials from Plivo Console.
- We recommend that you store your credentials in the auth_id & auth_token environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and it will automatically fetch them from the environment variables
- You can use ENV to store environment variables and fetch them while initializing the client.
- Replace the placeholder the_callerID with the Phone number which you have purchased and the_destination_number with the phone number you will be making calls to.
- Both the_callerID and the_destination_number should be in E.164 format, for example +15671234567.
Save the file and use the below command to run it.
Receive Your First Inbound Call
In addition to having at least one voice-enabled Plivo phone number that is needed to receive incoming calls (as was mentioned earlier), you need the following:
Answer URL & Callback URLs
When a call is received on a Plivo voice-enabled number, you can control the call flow by declaring an answer URL for your Plivo application associated with that Plivo phone number. Plivo will invoke the answer URL specified and expect a valid XML response to handle the call.
Notice how the concept of Answer URLs applies to both outbound API calls as well as incoming calls to your Plivo numbers. In the outbound API call example above, we specified the answer URL along with the make call API request, whereas in the case of incoming calls to Plivo numbers, the answer URL is specified in the Plivo application associated with the phone number.
In addition to requests to the answer URL, Plivo initiates HTTP requests to your application server through the course of a call based on the specific XML elements in your answer XML. Such requests can be broadly classified into two categories:
Action URL requests: XML instructions to carry forward the call are expected in response to these requests. These requests are typically invoked at the end of an XML element’s execution. For example: when an IVR input is received from the caller during a GetInput XML execution.
Callback URL requests: No XML instructions are expected in response to these requests. Such requests serve as webhooks to notify your application server of important events through the course of an XML element’s execution. For example: when a conference participant is muted or unmuted.
To be able to host Answer and Callback URLs and to be able to provide valid XMLs and accept notifications on these URLs respectively, you need to host a webserver at your end.
Set up a Sinatra Server for Incoming Calls & Callbacks
In this section, we’ll walk you through how to set up a Sinatra server in under five minutes and start handling incoming calls & callbacks.
Use the following code snippet to start a local server.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 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 this code in any file (let’s say the file name is
receive_call.rb). To run this file on the server, go to the folder where this file resides and use the following command:
And you should see your basic server app in action on http://localhost:4567/receive_call/
Exposing your local server to the internet
To receive Incoming Calls and to handle callbacks, your local server should be able to connect with Plivo API service, Ngrok is a tunneling software used to expose a web server running on your local machine to the internet. Using Ngrok you can set webhooks which can talk to Plivo server.
You can download and install ngrok from here. Follow the detailed configuration instructions to get started.
Run ngrok on the port which currently hosts your application. For example, if your port number is 80, run the following command:
./ngrok http <port_on_which_your_local_server_is_running>
This will give you a UI with links that look like
ngrok.io/* which you can use to access your local server using the public network.
Create an Application
- Create an Application by visiting the Application Page and click on
New Application. You can also use Plivo’s Application API.
- Give your application a name. Let’s call it
Receive_call. Enter your server URL (e.g.
http://example.com/receive_call/) in the
Answer URLfield and set the method as
POST. See our Application API docs to learn how to modify your application through our APIs.
- Click on
Createto save your application.
Assign a Plivo number to your app
- Navigate to the Numbers page and select the phone number you want to use for this app.
Receive Call(name of the app) from the Plivo App dropdown list.
- Click on
Test and validate
Make a call to your Plivo number using a regular mobile phone. Plivo will send a request to your
Answer URL requesting for a valid XML response and process the call. Meanwhile, the parameters listed in the XML Request - call status documentation will also be sent to your server.
Forward an Incoming call
To forward an incoming call, you need to use Dial XML.
- You should set up the dial XML document in your server
- URL of the dial XML in your server has to be set up as the answer_url of the app assigned to the Plivo number.
- During an incoming call to your Plivo number, Plivo will send a request to the answer_url expecting a valid XML to process the incoming call.
- As the response would be a dial XML, the call will be forwarded to the number defined in the XML response.
Create a file called
forward_call.rb and paste the below code.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 require 'rubygems' require 'plivo' include Plivo::XML include Plivo::Exceptions begin response = Response.new dial = response.addDial() dial.addNumber("15671234567") // call wll be forwarded to this number xml = PlivoXML.new(response) content_type "application/xml" return xml.to_s() end
Test and validate
Send an SMS to your Plivo number using a regular mobile phone and an automatic response will be sent from your Plivo number to your mobile phone. Also, Plivo will send a request to your
Message URL with the parameters listed in the XML Request - Messages Documentation.