Skip to main content

Documentation Index

Fetch the complete documentation index at: https://plivo.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Interactive voice response (IVR) systems let incoming callers access information and find contacts via a menu of prerecorded messages, without having to speak to an agent, and let you automate polling via outgoing calls. Callers and call recipients can respond to prompts via Touch-Tone keypad presses or speech recognition. IVR systems can handle larger call volumes than operators and reduce costs associated with customer service. Common IVR use cases include:
  • Auto-attendant: You can replace a receptionist with an IVR system that routes calls to agents during business hours and accepts voicemail when no one is available.
  • Call center: You can route calls coming in to call centers to the appropriate representatives based on user input.
  • Surveys, polling, and voting: You can implement IVR in outbound calls to collect customer satisfaction scores or conduct political polling.
  • Appointment reminders: You can send automated reminders to customers before their scheduled visits to help avoid missed appointments and facilitate rescheduling.
  • Lead assignment and lead routing: For inbound sales calls, you can set up an IVR menu with a set of qualifying questions to discover a customer’s interests, then redirect their call to a representative based on their responses.
This guide shows how to build an IVR menu system on the Plivo platform, either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.
Here‘s how to implement an IVR system using XML.

​
How it works

​
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 PHP development environment and a web server and safely expose that server to the internet.

​
Create a Laravel server to implement IVR

Change the project directory and run this command to create a Laravel controller for inbound calls.
php artisan make:controller IvrController
This generates a controller named IvrController in the app/http/controllers/ directory. Edit app/http/controllers/IvrController.php and paste into it this code.
<?php

namespace App\Http\Controllers;
require '../../vendor/autoload.php';
use Plivo\RestClient;
use Plivo\XML\Response;
use Illuminate\Http\Request;

class IvrController extends Controller
{
    // GetInput XML to handle the incoming call
    public function ivrMain()
    {
        # Message that Plivo reads when the caller dials in
        $IvrMessage = "Welcome to the demo. Press 1 to contact sales. Press 2 to contact support";
        # Message that Plivo reads when the caller does nothing
        $NoinputMessage = "Sorry, I didn't catch that. Please hang up and try again";
        # Message that Plivo reads when the caller enters an invalid number.
        $WronginputMessage = "Sorry, that's not a valid entry";
        
        // Sales Phone Number
        $salesPhoneNumber = "+15671234567";

        // support Phone Number
        $supportPhoneNumber = "+15671234578";
        
        $r = new Response();
        $getinput_action_url = "https://<yourdomain>.com/firstbranch.php";
        $get_input = $r->addGetInput([
                    'action' => $getinput_action_url,
                    'method' => "POST",
                    'digitEndTimeout' => "5",
                    'inputType' => "dtmf",
                    'redirect' => "true",
                ]);
        $get_input->addSpeak($IvrMessage);
        $r->addSpeak($NoinputMessage);
        Header('Content-type: text/xml');
        echo $r->toXML();
    }
    
    // Action URL block for DTMF 
    public function firstBranch(Request $request)
    {
        # File to be played when a caller presses 2
        $PlivoSong = "https://s3.amazonaws.com/plivocloud/music.mp3";
        $IvrMessage = "Press 1 for English. Press 2 for French. Press 3 for Russian";
        # Message that Plivo reads when the caller does nothing
        $NoinputMessage = "Sorry, I didn't catch that. Please hang up and try again";
        # Message that Plivo reads when the caller enters an invalid number
        $WronginputMessage = "Sorry, that's not a valid entry";
    
        $r = new Response();
    
        $digit = $_REQUEST['Digits'];
        if ($digit == '1'){
        $dial = $response->addDial();
        $dial->addNumber($salesPhoneNumber);
        }
        else if ($digit == '2'){
            $dial = $response->addDial();
            $dial->addNumber($supportPhoneNumber);
        }
        else {
            $r->addSpeak($WronginputMessage);
        }
        Header('Content-type: text/xml');
        echo $r->toXML();
    }
}

​
Add a route

Add a route for the forward function in the IvrController class. Edit routes/web.php and add these lines:
Route::match(['get', 'post'], '/ivr', 'IvrController@ivrMain');
Route::match(['get', 'post'], '/firstbranch', 'IvrController@firstBranch');
Start the Laravel server.
php artisan serve
You should see your basic server application in action at http://localhost:8000/ivr.Set up ngrok to expose your local server to the internet.

​
Create a Plivo application

Associate the Laravel server 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 Phone IVR. Enter the server URL you want to use (for example https://<yourdomain>.com/ivr/) in the Answer URL field and set the method to GET. 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 Phone IVR (the name we gave the application).Click Update Number to save.

​
Test

Make a call to your Plivo phone number and see how the IVR application works.