Get Started with Ruby on Rails 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:

    1. Sign up with your work email address
    2. Check your inbox for an activation email from Plivo. Click on the link in the email to activate your account.
    3. Enter your mobile number to complete the phone verification step.

    Sign up with your work email address

    Sign up with email addres

    If you have any issues creating a Plivo account, please reach out to our Support Team for assistance.

    Start your implementation with Plivo to make/receive calls using PHLO or the traditional API/XML way. PHLO allows you to create the call flows using its intuitive canvas and deploy it with few clicks. Refer to the instructions from the respective tabs below to start your integration with PHLO or XML as you wish.

    Make Your First Outbound Call

    To make your first outbound call, you can create and deploy a PHLO in just a few clicks using the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, only pay for calls you make/receive. Building with PHLO is free.

    Prerequisites

    1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
    2. Set Up Your Ruby Dev Environment: To set up your dev environment in Ruby, please refer to the instructions available in the Set Up Your Ruby Dev Environment section.
    3. Buy a Plivo Number(optional): You must have a voice-enabled Plivo phone number if you wish to receive incoming calls. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.

    Create the PHLO

    Create a PHLO to make your first outbound call by following these instructions:

    Create a PHLO for outbound calls

    • On the side navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any exist. If this is your first PHLO, then the PHLO page will be empty.
    • Click Create New PHLO to build a new PHLO.
    • In the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node.
      Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the start node; Incoming SMS, Incoming Call, and API Request. For this PHLO, we will use the API Request trigger state.
    • From the list of components on the left-hand side, drag and drop the Initiate Call component onto the canvas. This will add an Initial Call node onto the canvas.
    • Connect the Start node with the Initiate Call node, using the API Request trigger state.
    • Configure the Initiate Call node with the caller ID using the From field. Enter the destination number you wish to call in the To field.
    • Once you have configured the node, click Validate to save the configurations.
    • Similarly, create a node for the Play Audio component and connect it to the Initiate Call node using the Answered trigger state.
    • Next, configure the Play Audio node to play a specific message to the user. For example, “Hello! You just received your first inbound call”.
    • Connect the Initiate Call node with the Play Audio node, using the Answered trigger state.
    • After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready. You can trigger the PHLO and test it out. For more information, refer to the following section.

    Set Up Your Ruby Dev Environment

    You must set up and install Ruby and Plivo’s Ruby SDK to make your first call. Here’s how.

    Install Ruby

    Operating SystemInstructions
    OS X & LinuxTo see if you already have Ruby installed, run the command ruby --version in the terminal. If you don't have it installed, you can install it using homebrew.
    WindowsTo 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:

      $ bundle
      
    • Or install it yourself as:

      $ gem install plivo
      

    Trigger the PHLO

    Once you have created and setup your Ruby dev envrironment, you can go to your Plivo Consolse and copy the PHLO_ID. Integrate a PHLO into your application workflow by making an API request to trigger the PHLO with the required payload.

    With Static Payload

    You can choose to either configure the mandatory params required for a PHLO while creating the PHLO itself or, you can pass the params as payload while triggering the PHLO from your app.

    Note: When you configure the params while creating the PHLO, the values are hardcoded and act as static payload.

    With Static Payload

    Code

    Now, create a file called trigger_phlo.rb and paste the following code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    
    require 'rubygems'
    require 'plivo'
    
    include Plivo
    
    AUTH_ID = 'AUTH_ID'
    AUTH_TOKEN = 'AUTH_TOKEN'
    
    client = Phlo.new(AUTH_ID, AUTH_TOKEN)
    
    # if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
    # then initialize client as:
    # client = Phlo.new
    
    begin
      phlo = client.phlo.get('phlo_id')
      response = phlo.run()
      puts response
    rescue PlivoRESTError => e
      puts 'Exception: ' + e.message
    end
    

    With Dynamic Payload

    To use dynamic values for the parameters, use the liquid templating params while creating the PHLO and pass the values while triggering the PHLO.

    With Dynamic Payload

    Code

    Now, create a file called trigger_phlo.rb and paste the following code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    
    require 'rubygems'
    require 'plivo'
    
    include Plivo
    
    AUTH_ID = 'AUTH_ID'
    AUTH_TOKEN = 'AUTH_TOKEN'
    
    client = Phlo.new(AUTH_ID, AUTH_TOKEN)
    
    # if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
    # then initialize client as:
    # client = Phlo.new
    
    begin
      phlo = client.phlo.get('phlo_id')
      #parameters set in PHLO - params
      params = {
         from: '+14157778888',
         to: '+14157778889'
      }
      response = phlo.run(params)
      puts response
    rescue PlivoRESTError => e
      puts 'Exception: ' + e.message
    end
    

    Get your Auth_ID and Auth_token from your dashboard AUTHID

    You can find the PHLO_ID on the PHLO Listing page. PHLO Listing

    Test and Validate

    Save the file and use the below command to run your code.

    $ ruby trigger_phlo.rb
    
    Note: If you are using a Plivo Trial account for this example, you can only make calls to phone numbers that have been verified with Plivo. Phone numbers can be verified at the Sandbox Numbers page.

    Receive Your First Inbound call

    Create and deploy a PHLO to receive your first inbound call with a few clicks on the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, only pay for calls you make/receive. Building with PHLO is free.

    Prerequisites

    1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
    2. Buy a Plivo number: You must have a voice-enabled Plivo phone number to receive incoming calls. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.
    3. PHLO Application: When you receive a call on a Plivo voice-enabled number, you can control the call flow by associating a PHLO application to that Plivo phone number. Plivo will fetch the PHLO associated with the number and expect valid instructions via PHLO to handle the call.

    Create the PHLO

    You can create a PHLO by referring to the below instructions to receive your first incoming call:

    Create a PHLO to receive incoming call

    • On the side navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any exist. If this is your first PHLO, then the PHLO page will be empty.
    • Click Create New PHLO to build a new PHLO.
    • In the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node.
      Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the start node; Incoming SMS, Incoming Call, and API Request. For this PHLO, we will use the API Request trigger state.
    • From the list of components on the left-hand side, drag and drop the Play Audio component onto the canvas. This will add a Play Audio node onto the canvas.
    • Connect the Start node with the Play Audio node, using the Incoming Call trigger state.
    • Configure the Play Audio node to play a specific message to the user. For example, “Hello! You just received your first inbound call”.
    • Once you have configured the node, click Validate to save the configurations.
    • After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready.

    Assign the PHLO to a Plivo Number for Incoming Calls

    Once you have created and configured your PHLO, assign your PHLO to a Plivo number.

    To assign a PHLO to a number:

    1. Log in to your Plivo Console
    2. On the Product Navigation bar, click Phone Numbers.
    3. On the Numbers page, under Your Numbers, click the phone number you wish to use for the PHLO.
    4. In the Number Configuration window, select PHLO from the Application Type list.
    5. From the PHLO Name list, select the PHLO you wish to use with the phone number, and then click Update Number.

    Assign PHLO to a Plivo Number

    If you have not purchased a phone number yet, you can buy a phone number(s) by referring to the instructions available here.

    Test and Validate

    You can now make a call to your Plivo phone number to receive an incoming call and see how the inbound call is handled using PHLO.

    For more information about creating a PHLO app, see the PHLO User Guide.
    For information on components and their variables, see the PHLO Components Library.

    Forward an Incoming call

    To forward an incoming call, you can create and deploy a PHLO with a few clicks on the PHLO canvas.

    Prerequisites

    1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
    2. Buy a Plivo number: You must have a voice-enabled Plivo phone number to receive incoming calls. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.
    3. PHLO Application: When you receive a call on a Plivo voice-enabled number, you can control the call flow by associating a PHLO application to that Plivo phone number. Plivo will fetch the PHLO associated with the number and expect valid instructions via PHLO to handle the call.

    Create the PHLO

    You can create a PHLO by referring to the below instructions to forward an incoming call:

    Create a PHLO to receive incoming call

    • On the side navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any exist. If this is your first PHLO, then the PHLO page will be empty.
    • Click Create New PHLO to build a new PHLO.
    • In the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node.
      Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the start node; Incoming SMS, Incoming Call, and API Request. For this PHLO, we will use the API Request trigger state.
    • From the list of components on the left-hand side, drag and drop the Call Forward component onto the canvas. This will add a Call Forward node onto the canvas.
    • Connect the Start node with the Call Forward node, using the Incoming Call trigger state.
    • Configure the Call Forward node with the phone number to which you want to forward the call. For example, in this case, “+14157778889”.
    • Once you have configured the node, click Validate to save the configurations.
    • After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready.

    Assign the PHLO to a Plivo Number to Forward Incoming Calls

    Once you have created and configured your PHLO, assign your PHLO to a Plivo number.

    To assign a PHLO to a number:

    1. Log in to your Plivo Console
    2. On the Product Navigation bar, click Phone Numbers.
    3. On the Numbers page, under Your Numbers, click the phone number you wish to use for the PHLO.
    4. In the Number Configuration window, select PHLO from the Application Type list.
    5. From the PHLO Name list, select the PHLO you wish to use with the phone number, and then click Update Number.

    Assign PHLO to a Plivo Number

    If you have not purchased a phone number yet, you can buy a phone number(s) by referring to the instructions available here.

    Test and Validate

    You can now make a call to your Plivo phone number and see how the inbound call is forwarded to the phone number specified in the PHLO.

    For more information about creating a PHLO app, see the PHLO User Guide.
    For information on components and their variables, see the PHLO Components Library.

    Install Rails and the Plivo Ruby SDK

    You must install rails, create a rails project and add Plivo’s Ruby SDK to make your first call. Here’s how.

    Install Rails

    Use the below command to install Rails

    $ gem install rails
    

    Create a Rails Project

    As we have Rails and its dependencies installed, we can use them to create a new Rails project. As the initial step, using rails we can auto-generate code in the ruby on rails folder structure. Use the below command to start your Rails project.

    $ rails new plivotest
    

    This will create a plivotest directory with the necessary folders & files for development.

    Install Plivo

    As we have the rails application created, now, let’s add Plivo-Ruby by modifying the Gemfile. Open the Gemfile in any IDE/text-editor and add the following line:

    gem 'plivo', '~> 4.13.0'
    

    You can use the below command to install the Plivo-Ruby gem into the bundle:

    $ bundle install
    

    Make your first Outbound Call

    Prerequisites

    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 Auth Id and Auth Token: You will find your Plivo Auth Id and Auth Token on the home screen of your Plivo Console. Click here to sign-up for a Plivo account if you haven’t already!

      Find Your Auth Credentials on Plivo Console

    • Plivo Phone Number(Optional): 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.

      Buy a New Plivo Number

    • 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.

    Create a Rails Controller

    Change the directory to our newly created project directory, i.e, plivotest directory and run the below command to create a rails controller for outbound call.

    $ rails generate controller Plivo voice
    

    This will generate a controller named plivo_controller in the app/controllers/ directory and a respective view will be generated in app/views/plivo directory. We can delete the View as we will not need it.

    $ rm app/views/plivo/voice.html.erb
    

    Now, You have to open the app/controllers/plivo_controller.rb file and add the following code:

    Code

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    
    include Plivo
    include Plivo::Exceptions
    
    class PlivoController < ApplicationController
     def outbound
       api = RestClient.new("<auth_id>","<auth_token>")
       response = api.calls.create(
         '+14151234567',
         ['+14157654321'],
         'http://s3.amazonaws.com/static.plivo.com/answer.xml'
       )
       puts response
       render json: response.to_s
     end
    end
    
    Note:
    • 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
    • Replace the placeholder +14151234567 with the Phone number which you have purchased and +14157654321 with the phone number you will be making calls to.
    • Both +14151234567 and +14157654321 should be in E.164 format

    Add a Route

    Now, to add a route for the outbound function in the PlivoController class, open the config/routes.rb file and change the line:

    get 'plivo/voice' 
    

    to

    get 'plivo/outbound'
    

    Test & Validate

    Now the plivo_controller is ready for your first outbound call, you can use the below command to initiate your first outbound using Rails and Plivo Ruby SDK.

    $ rails server
    

    Your local development server will be started and you can test the rails app for outbound calls via the URL http://127.0.0.1:3000/plivo/outbound/.

    Note: If you are using a Plivo Trial account for this example, you can only make calls to phone numbers that have been verified with Plivo. Phone numbers can be verified at the Sandbox Numbers page.

    Receive Your First Inbound Call

    Prerequisites

    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.

    Web Server

    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 Rails Server for Incoming Calls & Callbacks

    In this section, we’ll walk you through how to set up a Rails server in under five minutes and start handling incoming calls & callbacks.

    Now, open the app/controllers/plivo_controller.rb file and add include the following code in the PlivoController class after the outbound function:

    1
    2
    3
    4
    5
    6
    7
    8
    
    def inbound
       response = Response.new
       speak_body = 'Hello, you just received your first call'
       response.addSpeak(speak_body)
    
       xml = Plivo::PlivoXML.new(response)
       render xml: xml.to_xml
     end
    

    Add a Route

    Now, you need to add a route for the inbound function in PlivoController class, open the config/routes.rb file and add the below line after the outbound route:

    get 'plivo/inbound'
    

    Test & Validate

    Now the plivo_controller is ready for your first inbound call, you can use the below command to receive your first inbound using Rails and Plivo Ruby SDK.

    $ rails server
    

    Your local development server will be started and you can test the rails app for inbound calls via the URL http://127.0.0.1:3000/plivo/inbound/.

    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.

    ngrok block diagram

    You can download and install ngrok from here. Follow the detailed configuration instructions to get started.

    Note: Before starting Ngrok service, you need to add ngrok in the config.hosts list in the config/environments/development.rb file and include the below line. You will start facing Blocked host error if you fail to add this.
    # Whitelist Ngrok domain
    config.hosts << /[a-z0-9]+\.ngrok\.io/
    

    Run ngrok on the port which currently hosts your application. For example, if your port number is 3000, run the following command:

    ./ngrok http 3000
    

    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.

    ngrok CLI

    You can check the app in action on https://6ea358b0f703.ngrok.io/receivecall/ and check the XML response as shown below:

    Sample XML

    Create a Plivo Application

    1. Create an Application by visiting the Application Page and click on New Application. You can also use Plivo’s Application API.
    2. 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 URL field and set the method as POST. See our Application API docs to learn how to modify your application through our APIs.
    3. Click on Create to save your application.

    Create Application

    Assign a Plivo number to your app

    1. Navigate to the Numbers page and select the phone number you want to use for this app.
    2. Select Receive Call (name of the app) from the Plivo App dropdown list.
    3. Click on Update to save.

    Assign Phone Number to Receive Call App

    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.
    Note: The phone number must be a Plivo phone number that is voice-enabled. You can purchase a Plivo number from the Buy Numbers tab on your Plivo Console and filter the phone numbers by selecting voice in the features option to buy voice-enabled numbers.

    Now, open the app/controllers/plivo_controller.rb file and add include the following code in the PlivoController class after the inbound function:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    
    def forward
       response = Response.new
       dial = response.addDial()
       dest_number = "14151234567"
       dial.addNumber(dest_number)
    
       xml = PlivoXML.new(response)
       puts xml.to_xml
       render xml: xml.to_xml
     end
    

    Add a Route

    Now, you need to add a route for the inbound function in PlivoController class, open the config/routes.rb file and add the below line after the inbound route:

    get 'plivo/forward'
    

    Test & Validate

    Now the plivo_controller is ready to forward the incoming calls to your Plivo numberl, you can use the below command to start the Rails server to forward incoming calls and to handle callbacks.

    $ rails server
    

    Your local development server will be started and you can test the rails app for outbound calls via the URL http://127.0.0.1:3000/plivo/forward/.

    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. Once Plivo receives the dial XML response, the call will be forwarded to the number defined in the XML. Meanwhile, the parameters listed in the XML Request - call status documentation will also be sent to your server.