Voicemail Using Ruby

    Overview

    You can use voicemail to capture a caller’s message if a call recipient is unavailable. This guide shows how to set up voicemail, either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

    You can create and deploy a workflow to implement voicemail with a few clicks on the PHLO canvas.

    Voicemail call flow

    Prerequisites

    To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. To receive incoming calls, you must have a voice-enabled Plivo phone number. You can rent numbers from the Numbers page of the Plivo console, or by using the Numbers API.

    Create the PHLO

    To create a PHLO, visit the PHLO page of the Plivo console. If this is your first PHLO, the PHLO page will be empty.

    • Click CREATE NEW PHLO.

    • In the Choose your use case pop-up, click Build my own. The PHLO canvas will appear with the Start node.
      Note: The Start node is the starting point of any PHLO. It lets you trigger a PHLO to start upon one of three actions: incoming SMS message, incoming call, or API request.
    • Click the Start node to open the Configuration tab, then enter from and to as keys in the API Request section. To keep the PHLO dynamic, don‘t enter values for the variables.

    • Once you’ve configured the node, save the configuration by clicking Validate. Do the same for each node as you go along.

    • From the list of components on the left side, drag and drop the Record Audio component onto the canvas. When a component is placed on the canvas it becomes a node. In its Configuration tab, give the node a descriptive name, such as Voicemail_Message, and enter text for a message you want to play to callers.

    • Draw a line to connect the Start node‘s Incoming Call trigger state to the Record Audio node.

    • Once a message is recorded, send the URL of the recording to a responsible party. To do that, drag and drop the Send Message component into the canvas, and rename it Send_Recording_URL.

    • In its Configuration tab, enter variables for the From and To fields. Enter two curly brackets to view all available variables, and choose the appropriate ones. PHLO will get the number from the key/value pairs set in the Start node. In the Message field, enter a message that provides context for the voicemail recipient. The message can be static or dynamic or a combination of the two.

    • Give the PHLO a name by clicking in the upper left, then click Save.

    Your complete PHLO should look like this.

    Voicemail

    Assign the PHLO to a Plivo number

    Once you‘ve created and configured your PHLO, assign it to a Plivo number.

    • On the Numbers page of the console, under Your Numbers, click the phone number you want to use for the PHLO.
    • In the Number Configuration box, select PHLO from the Application Type drop-down.
    • From the PHLO Name drop-down, select the PHLO you want to use with the phone number, then click Update Number.

    Assign PHLO to a Plivo Number

    Test

    You can now call your Plivo phone number and see how the voicemail PHLO works.

    For more information about creating a PHLO application, see the PHLO Getting Started guide. For information on components and their variables, see the PHLO Components Library.

    Here’s how to implement voicemail using XML.

    How it works

    Voicemail Call Flow

    Prerequisites

    To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. 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. If this is your first time using Plivo APIs, follow our instructions to set up a Ruby development environment and a web server and safely expose that server to the internet.

    Create a Rails controller to implement voicemail

    Change to the project directory and run this command to create a Rails controller for inbound calls.

    $ rails generate controller Plivo voice
    

    This command generates a controller named plivo_controller in the app/controllers/ directory and a respective view in app/views/plivo. We can delete the view as we do not need it.

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

    Edit app/controllers/plivo_controller.rb and paste this code into the PlivoController class.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    
    include Plivo
    include Plivo::XML
    include Plivo::Exceptions
    
    class PlivoController < ApplicationController
    	def voicemail
    		response = Response.new
    
    		first_speak_body = 'Please leave a message after the beep. Press the star key when done.'
    		response.addSpeak(first_speak_body)
    
    		params = {
    			action: 'https://www.foo.com/get_recording/',
    			maxLength: '30',
    			finishOnKey: '*'
    		}
    		response.addRecord(params)
    
    		second_speak_body = 'Recording not received.'
    		response.addSpeak(second_speak_body)
    				xml = PlivoXML.new(response)
    		render xml: xml.to_xml
    	end
    end
    

    Add a route

    To add a route for the inbound function in the PlivoController class, edit config/routes.rb and add this line after the inbound route.

    get 'plivo/voicemail'
    

    Start the Rails server

    $ rails server
    

    You should see your basic server application in action at http://localhost:3000/plivo/voicemail/.

    Create a Plivo application for voicemail

    Associate the Rails controller 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 Voicemail. Enter the server URL you want to use (for example https://<yourdomain>.com/voicemail/) in the Answer URL field and set the method to GET. Click Create Application to save your application.

    Plivo Create Application Voicemail

    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 Voicemail (the name we gave the application).

    Click Update Number to save.

    Assign Voicemail Application

    Test

    Make a call to your Plivo number and leave yourself a voicemail message.