Record a Voicemail

Latest Legacy

This example shows a simple voicemail recording. The caller is asked to leave a message after the beep. The Record element beeps and begins recording up to 30 seconds of audio.

If the caller remains silent, the Record element exits after a default timeout of 15 seconds, falling through to the next element — in this case, the Speak element.

After the voicemail is recorded, Plivo POSTs the recorded URL to the action URL.

Response

<Response>
  <Speak>Please leave a message after the beep. Press the star key when done.</Speak>
  <Record action="https://<yourdomain>.com/get_recording/" finishOnKey="*" maxLength="30"></Record>
  <Speak>Recording not received.</Speak>
</Response>

Example Request

1
2
3
4
5
6
7
8
9
10
11
12
13
from plivo import plivoxml

response = plivoxml.ResponseElement()
response.add(
    plivoxml.SpeakElement(
        "Please leave a message. Press the star key or hang up when you're done."))
response.add(
    plivoxml.RecordElement(
        action='https://<yourdomain>.com/get_recording/',
        max_length=30,
        finish_on_key='*'))
response.add(plivoxml.SpeakElement('Recording not received.'))
print(response.to_string())

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
27
require 'rubygems'
require 'plivo'

include Plivo::XML
include Plivo::Exceptions

begin
  response = Response.new

  first_speak_body = "Please leave a message. Press the star key or hang up when you're done."
  response.addSpeak(first_speak_body)

  params = {
      action: 'https://<yourdomain>.com/get_recording/',
      maxLength: '30',
      finishOnKey: '*'
  }
  response.addRecord(params)

  second_speak_body = 'Recording not received.'
  response.addSpeak(second_speak_body)

  xml = PlivoXML.new(response)
  puts xml.to_xml
rescue PlivoXMLError => e
  puts 'Exception: ' + e.message
end

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
27
var plivo = require('plivo');

var response = plivo.Response();

var first_speak_body ="Please leave a message. Press the star key or hang up when you're done.";
response.addSpeak(first_speak_body);

var params = {
    'action': "https://<yourdomain>.com/get_recording/",
    'maxLength': "30",
    'finishOnKey': "*"
};
response.addRecord(params);

var second_speak_body = "Recording not received.";
response.addSpeak(second_speak_body);

console.log(response.toXML());

/*
Sample Output
<Response>
    <Speak>Please leave a message. Press the star key or hang up when you're done.</Speak>
    <Record action="https://<yourdomain>.com/get_recording/" maxLength="30" finishOnKey="*"/>
    <Speak>Recording not received.</Speak>
</Response>
*/

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
27
28
29
30
31
32
33
34
<?php
    require '../vendor/autoload.php';
    use Plivo\XML\Response;

    $response = new Response();

    $first_speak_body = "Please leave a message. Press the star key or hang up when you're done.";

    $response->addSpeak($first_speak_body);

    $params = array(
        'action' => "https://<yourdomain>.com/get_recording/",
        'maxLength' => "30",
        'finishOnKey' => "*"
    );

    $response->addRecord($params);

    $second_speak_body = "Recording not received.";
    $response->addSpeak($second_speak_body);

    Header('Content-type: text/xml');
    echo($response->toXML());

    /*
    Sample Output

    <Response>
        <Speak>Please leave a message. Press the star key or hang up when you're done.</Speak>
        <Record action="https://<yourdomain>.com/get_recording/" maxLength="30" finishOnKey="*"/>
        <Speak>Recording not received.</Speak>
    </Response>
    */
?>

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
27
28
29
// Example for record - record a voicemail
package com.plivo.api.xml.samples.record;

import com.plivo.api.exceptions.PlivoXmlException;
import com.plivo.api.xml.Record;
import com.plivo.api.xml.Response;
import com.plivo.api.xml.Speak;


class RecordAVoicemail {
    public static void main(String[] args) throws PlivoXmlException {
        Response response = new Response()
                .children(


                        new Speak("Please leave a message. Press the star key or hang up when you're done."),


                        new Record("https://<yourdomain>.com/get_recording/")
                                .finishOnKey("*")
                                .maxLength(20),


                        new Speak("Recording not received.")

                );
        System.out.println(response.toXmlString());
    }
}

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
27
28
29
30
31
32
33
34
35
36
using System;
using System.Collections.Generic;
using Plivo.XML;

namespace Plivo
{
	class MainClass
	{
		public static void Main(string[] args)
		{
			Plivo.XML.Response resp = new Plivo.XML.Response();
			resp.AddSpeak("Please leave a message. Press the star key or hang up when you're done.",
				new Dictionary<string, string>() { });
			resp.AddRecord(new Dictionary<string, string>() {
				{"action", "https://<yourdomain>.com/get_recording/"},
				{"maxLength", "30"},
				{"finishOnKey", "*"}
			});
			resp.AddSpeak("Recording not received.",
				new Dictionary<string, string>() { });

			var output = resp.ToString();
			Console.WriteLine(output);

		}
	}
}



//<Response>
//  <Speak>Please leave a message. Press the star key or hang up when you're done.</Speak>
//  <Record action = "https://<yourdomain>.com/get_recording/" 
//    maxLength="30" finishOnKey="*" />
//  <Speak>Recording not received.</Speak>
//</Response>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Example for record - record voicemail
package main

import "github.com/plivo/plivo-go/v7/xml"

func main() {
	response := xml.ResponseElement{
		Contents: []interface{}{

			new(xml.SpeakElement).
				AddSpeak("Please leave a message. Press the star key or hang up when you're done"),

			new(xml.RecordElement).
				SetAction("https://<yourdomain>.com/get_recording/").
				SetFinishOnKey("*").
				SetMaxLength(20),

			new(xml.SpeakElement).
				AddSpeak("Recording not received."),
		},
	}
	print(response.String())
}

Example Request

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
27
28
29
30
31
32
33
34
35
from flask import Flask, Response, request
import plivoxml

app=Flask(__name__)

@app.route('/record/voice_mail', methods=['GET','POST'])
def voice_mail():
	response = plivoxml.Response()
	response.addSpeak("Leave message. Press star key when done")

	params = {
		'maxLength' : "20",
		'action' : "https://foo.com/get_recording/",
		'finishOnKey' : "*"
	}
	response.addRecord(**params)
	response.addSpeak("Recording not received.")

	return Response(str(response), mimetype='text/xml')



if __name__ == "__main__":
	app.run(host='0.0.0.0', debug=True)

# Sample Conference XML
# <Response>
#	<Speak>
#		Leave message. 
#		Press star key when done
#	</Speak>
#	<Record action="https://foo.com/get_recording/" 
#	finishOnKey="*" maxLength="20"/>
#	<Speak>Recording not received.</Speak>
# </Response>

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
27
28
29
require 'rubygems'
require 'plivo'
include Plivo

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)

puts response.to_xml()

=begin
Sample Output
<Response>
    <Speak>Please leave a message after the beep. Press the star key when done.</Speak>
    <Record action='https://www.foo.com/get_recording/' finishOnKey='*' maxLength='30'/>
    <Speak>Recording not received.</Speak>
</Response>
=end

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
27
28
var plivo = require('plivo');

var response = plivo.Response();

var first_speak_body ="Please leave a message after the beep. Press the star key when done.";
response.addSpeak(first_speak_body);

var params = {
    'action': "https://www.foo.com/get_recording/",
    'maxLength': "30",
    'finishOnKey': "*"
};
response.addRecord(params);

var second_speak_body = "Recording not received.";
response.addSpeak(second_speak_body);

console.log(response.toXML());

/*
Sample Output
<Response>
    <Speak>Please leave a message after the beep. Press the
    star key when done.</Speak>
    <Record action="https://www.foo.com/get_recording/" maxLength="30" finishOnKey="*"/>
    <Speak>Recording not received.</Speak>
</Response>
*/

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
27
28
29
30
31
32
33
34
<?php
    require '../vendor/autoload.php';
    use Plivo\Response;

    $response = new Response();

    $first_speak_body = "Please leave a message after the beep. Press the star key when done.";

    $response->addSpeak($first_speak_body);

    $params = array(
        'action' => "https://www.foo.com/get_recording/",
        'maxLength' => "30",
        'finishOnKey' => "*"
    );

    $response->addRecord($params);

    $second_speak_body = "Recording not received.";
    $response->addSpeak($second_speak_body);

    Header('Content-type: text/xml');
    echo($response->toXML());

    /*
    Sample Output

    <Response>
        <Speak>Please leave a message after the beep. Press the star key when done.</Speak>
        <Record action="https://www.foo.com/get_recording/" maxLength="30" finishOnKey="*"/>
        <Speak>Recording not received.</Speak>
    </Response>
    */
?>

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
import java.io.IOException;

import com.plivo.helper.exception.PlivoException;
import com.plivo.helper.xml.elements.Record;
import com.plivo.helper.xml.elements.Speak;
import com.plivo.helper.xml.elements.PlivoResponse;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;

public class recordVoicemail extends HttpServlet {
    private static final long serialVersionUID = 1L;    
    @Override
    protected void doGet(HttpServletRequest req, 
        HttpServletResponse resp)
            throws ServletException, IOException {
        
        PlivoResponse response = new PlivoResponse();
        Speak speak1 = new 
        Speak("Leave message. Press star key when done.");
        Record record = new Record();
        record.setAction("https://foo.com/get_recording");
        record.setMaxLength(30);
        record.setFinishOnKey("*");
        Speak speak2 = new Speak("Recording not received.");
        
        try {
            response.append(speak1);
            response.append(record);
            response.append(speak2);
            System.out.println(response.toXML());
            resp.addHeader("Content-Type", "text/xml");
            resp.getWriter().print(response.toXML());;
        } catch (PlivoException e) {
            e.printStackTrace();
        }       
    }

    public static void main(String[] args) throws Exception {
        String port = System.getenv("PORT");
        if(port==null)
            port ="8000";
        Server server = new Server(Integer.valueOf(port));
        ServletContextHandler context = new 
        ServletContextHandler(ServletContextHandler.SESSIONS);
        context.setContextPath("/");
        server.setHandler(context);
        context.addServlet(new 
            ServletHolder(new 
                recordVoicemail()), "/record/voicemail");
        server.start();
        server.join();
    }
}

/*
Sample Output
<Response>
    <Speak>Leave message. Press star key when done.</Speak>
    <Record action="https://foo.com/get_recording" 
    maxLength="30" finishOnKey="*"/>
    <Speak>Recording not received.</Speak>
</Response>
*/

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
27
28
29
30
31
32
33
34
35
36
using System;
using System.Collections.Generic;
using Plivo.XML;

namespace Plivo
{
	class MainClass
	{
		public static void Main(string[] args)
		{
			Plivo.XML.Response resp = new Plivo.XML.Response();
			resp.AddSpeak("Leave message after the beep.",
				new Dictionary<string, string>() { });
			resp.AddRecord(new Dictionary<string, string>() {
				{"action", "https://foo.com/get_recording/"},
				{"maxLength", "30"},
				{"finishOnKey", "*"}
			});
			resp.AddSpeak("Recording not received.",
				new Dictionary<string, string>() { });

			var output = resp.ToString();
			Console.WriteLine(output);

		}
	}
}



//<Response>
//  <Speak>Leave message after the beep.</Speak>
//  <Record action = "https://foo.com/get_recording/" 
//    maxLength="30" finishOnKey="*" />
//  <Speak>Recording not received.</Speak>
//</Response>

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
    // Example for record - record voicemail
package main

import "github.com/plivo/plivo-go/v7/xml"

func main() {
	response := xml.ResponseElement{
		Contents: []interface{}{

			new(xml.SpeakElement).
				AddSpeak("Please leave a message. Press the star key or hang up when you're done"),

			new(xml.RecordElement).
				SetAction("https://<yourdomain>.com/get_recording/").
				SetFinishOnKey("*").
				SetMaxLength(20),

			new(xml.SpeakElement).
				AddSpeak("Recording not received."),
		},
	}
	print(response.String())
}

Rate this page

🥳 Thank you! It means a lot to us!