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
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 Python development environment and a web server and safely expose that server to the internet.Create a voice survey application in PHP
Create a file called survey.py and paste into it this code.# -*- coding: utf-8 -*-
from flask import Flask, Response, request, url_for
from plivo import plivoxml
# Message that Plivo reads when the call recipient answers
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"
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
negative_feedback = "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
noinput_message = "Sorry, I didn't catch that. Please hang up and try again"
# Message that Plivo reads when the caller enters an invalid number
wronginput_message = "Sorry, that's not a valid entry"
app = Flask(__name__)
@app.route('/survey/', methods=['GET','POST'])
def ivr():
response = plivoxml.ResponseElement()
getinput_action_url = "https://<yourdomain>.com/firstbranch/"
response.add(plivoxml.GetInputElement().
set_action(getinput_action_url).
set_method('POST').
set_input_type('dtmf').
set_digit_end_timeout(5).
set_redirect(True).add(
plivoxml.SpeakElement(question1)))
response.add(plivoxml.SpeakElement(noinput_message))
return Response(response.to_string(), mimetype='application/xml')
@app.route('/survey/firstbranch/', methods=['GET','POST'])
def firstbranch():
response = plivoxml.ResponseElement()
digit = request.values.get('Digits')
if digit == "1":
# Read out a text.
getinput_action_url = "https://<yourdomain>.com/secondbranch/"
response.add(plivoxml.GetInputElement().
set_action(getinput_action_url).
set_method('POST').
set_input_type('dtmf').
set_digit_end_timeout(5).
set_redirect(True).add(
plivoxml.SpeakElement(question2)))
response.add(plivoxml.SpeakElement(noinput_message))
elif digit == "2":
response.add_speak(negative_feedback)
else:
response.add_speak(wronginput_message)
return Response(response.to_string(), mimetype='application/xml')
@app.route('/ivr/secondbranch/', methods=['GET','POST'])
def secondbranch():
response = plivoxml.ResponseElement()
digit = request.values.get('Digits')
if digit == "1":
text = u"Thank you for participating in the survey"
params = {
'language': "en-GB",
}
response.add_speak(text,**params)
elif digit == "2":
response.add_speak(negative_feedback)
else:
response.add_speak(wronginput_message)
return Response(response.to_string(), mimetype='application/xml')
if __name__ == '__main__':
app.run(host='0.0.0.0', debug=True)
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 os module(os.environ) to store environment variables and fetch them when initializing the client.
Test
Make a call to a Plivo phone number and see how the survey application works. 
