Skip to main content

​
Overview

Plivo lets you automate voice surveys for use cases such as collecting feedback from customers and conducting polling on political issues. You can set up multiple levels of questions and walk users through different paths depending on the keys they press in response to your questions, and save the responses for analysis. You can implement voice surveys 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 use Plivo APIs and XML to implement voice surveys.

​
How it works

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.

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

​
Create a voice survey application in Java

Create a Java class called Survey and paste into it this code.
import static spark.Spark.*;

import com.plivo.api.xml.GetInput;
import com.plivo.api.xml.Play;
import com.plivo.api.xml.Response;
import com.plivo.api.xml.Speak;

public class IVR {
    public static void main(String[] args) {
        // Message that Plivo reads when the call recipient answers
        String Question1 = "Hi, this is a call from Plivo. How would you rate your overall satisfaction with our services? Press 1 if you're satisfied or 2 to suggest improvements";
        String Question2 = "How would you rate your satisfaction with our customer service? Press 1 if you're satisfied or 2 to suggest improvements";
        // Message that Plivo reads when the recipient provides negative feedback
        String NegativeFeedback = "We're sorry about your bad experience. One of our representatives will get in touch with you";
        // Message that Plivo reads when the caller does nothing
        String NoinputMessage = "Sorry, I didn't catch that. Please hang up and try again";
        // Message that Plivo reads when the caller enters an invalid number
        String WronginputMessage = "Sorry, that's not a valid entry";
        post("/survey/", (request, response) -> {
            response.type("application/xml");
            Response resp = new Response();
            resp.children(
                new GetInput()
                        .action("https://<yourdomain>.com/ivr/firstbranch/")
                        .method("POST")
                        .inputType("dtmf")
                        .digitEndTimeout(5)
                        .redirect(true)
                        .children(
                                new Speak(Question1)
                        )
            );
            resp.children(new Speak(NoinputMessage));
            return resp.toXmlString();
        });
        post("/survey/firstbranch/", (request, response) -> {
            response.type("application/xml");
            String digit = request.queryParams("Digits");
            Response resp = new Response();
            if (digit.equals("1")){
                resp.children(
                        new GetInput()
                                .action("https://<yourdomain>.com/ivr/secondbranch/")
                                .method("POST")
                                .inputType("dtmf")
                                .digitEndTimeout(5)
                                .redirect(true)
                                .children(
                                        new Speak(Question2)
                                )
                );
                resp.children(new Speak(NoinputMessage));
            }
            else if (digit.equals("2")){
                resp.children(
                        new Speak(NegativeFeedback)
                );
            }
            else {
                resp.children(
                        new Speak(WronginputMessage)
                );
            }
            return resp.toXmlString();
        });
        post("/survey/secondbranch/", (request, response) -> {
            response.type("application/xml");
            String digit = request.queryParams("Digits");
            Response resp = new Response();
            if (digit.equals("1")){
                resp.children(
                        new Speak("Thank you for participating in the survey", "MAN","en-GB",1)
                );
            }
            else if (digit.equals("2")){
                resp.children(
                        new Speak(NegativeFeedback)
                );
            }
            else {
                resp.children(
                        new Speak(WronginputMessage)
                );
            }
            return resp.toXmlString();
        });
    }
}
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 <a rel="nofollow" href="https://docs.oracle.com/javase/tutorial/essential/environment/env.html">System.getenv()</a> to store environment variables and retrieve them when initializing the client.
Save the file and run it. You should see your basic server application in action at http://localhost:4567/survey/.Set up ngrok to expose your local server to the internet.

​
Test

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