Record a conversation
A code snippet that shows how to record a conversation. Answer an incoming
call and return an NCCO that joins the caller to a named conversation. By
setting record
to true, the conversation is recorded and when the call is
complete, a webhook is sent to the eventUrl
you specify. The webhook includes
the URL of the recording.
Example
Prerequisites
A Vonage application contains the required configuration for your project. You can create an application using the Vonage CLI (see below) or via the dashboard. To learn more about applications see our Vonage concepts guide.
Install the CLI
npm install -g nexmo-cli
Create an application
Once you have the CLI installed you can use it to create a Vonage application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID
in the example below. It will also create private.key
in the current directory which you will need in the Initialize your dependencies step
Vonage needs to connect to your local machine to access your answer_url
. We recommend using ngrok to do this. Make sure to change demo.ngrok.io
in the examples below to your own ngrok URL.
nexmo app:create "Record Conversation Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
npm install express body-parser dotenv
Write the code
Add the following to record-a-conversation.js
:
require('dotenv').config({path: __dirname + '/../.env'})
const CONF_NAME = process.env.CONF_NAME
const app = require('express')()
const bodyParser = require('body-parser')
app.use(bodyParser.json())
const onInboundCall = (request, response) => {
const ncco = [{
"action": "conversation",
"name": CONF_NAME,
"record": "true",
"eventMethod": "POST", //This currently needs to be set rather than default due to a known issue https://help.nexmo.com/hc/en-us/articles/360001162687
"eventUrl": [`${request.protocol}://${request.get('host')}/webhooks/recordings`]
}]
response.json(ncco)
}
const onRecording = (request, response) => {
const recording_url = request.body.recording_url
console.log(`Recording URL = ${recording_url}`)
response.status(204).send()
}
app
.get('/webhooks/answer', onInboundCall)
.post('/webhooks/recordings', onRecording)
app.listen(3000)
Run your code
Save this file to your machine and run it:
node record-a-conversation.js
Prerequisites
A Vonage application contains the required configuration for your project. You can create an application using the Vonage CLI (see below) or via the dashboard. To learn more about applications see our Vonage concepts guide.
Install the CLI
npm install -g nexmo-cli
Create an application
Once you have the CLI installed you can use it to create a Vonage application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID
in the example below. It will also create private.key
in the current directory which you will need in the Initialize your dependencies step
Vonage needs to connect to your local machine to access your answer_url
. We recommend using ngrok to do this. Make sure to change demo.ngrok.io
in the examples below to your own ngrok URL.
nexmo app:create "Record Conversation Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
Add the following to `build.gradle`:
compile 'com.vonage:client:6.2.0'
compile 'com.sparkjava:spark-core:2.7.2'
Write the code
Add the following to the main
method of the RecordConversation
class:
/*
* Route to answer and connect incoming calls with recording.
*/
Route answerRoute = (req, res) -> {
String recordingUrl = String.format("%s://%s/webhooks/recordings", req.scheme(), req.host());
ConversationAction conversation = ConversationAction.builder(CONF_NAME)
.record(true)
.eventMethod(EventMethod.POST)
.eventUrl(recordingUrl)
.build();
res.type("application/json");
return new Ncco(conversation).toJson();
};
/*
* Route which prints out the recording URL it is given to stdout.
*/
Route recordingWebhookRoute = (req, res) -> {
System.out.println(RecordEvent.fromJson(req.body()).getUrl());
res.status(204);
return "";
};
Spark.port(3000);
Spark.get("/webhooks/answer", answerRoute);
Spark.post("/webhooks/recordings", recordingWebhookRoute);
Run your code
We can use the application
plugin for Gradle to simplify the running of our application.
Update your build.gradle
with the following:
apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''
Run the following gradle
command to execute your application, replacing com.vonage.quickstart.voice
with the package containing RecordConversation
:
gradle run -Pmain=com.vonage.quickstart.voice.RecordConversation
Prerequisites
A Vonage application contains the required configuration for your project. You can create an application using the Vonage CLI (see below) or via the dashboard. To learn more about applications see our Vonage concepts guide.
Install the CLI
npm install -g nexmo-cli
Create an application
Once you have the CLI installed you can use it to create a Vonage application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID
in the example below. It will also create private.key
in the current directory which you will need in the Initialize your dependencies step
Vonage needs to connect to your local machine to access your answer_url
. We recommend using ngrok to do this. Make sure to change demo.ngrok.io
in the examples below to your own ngrok URL.
nexmo app:create "Record Conversation Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
Install-Package Vonage
Create a file named RecordConversationController.cs
and add the following code:
using Vonage.Utility;
using Vonage.Voice.EventWebhooks;
using Vonage.Voice.Nccos;
Write the code
Add the following to RecordConversationController.cs
:
[HttpGet("webhooks/answer")]
public IActionResult Answer()
{
var CONF_NAME = Environment.GetEnvironmentVariable("CONF_NAME") ?? "CONF_NAME";
var host = Request.Host.ToString();
//Uncomment the next line if using ngrok with --host-header option
//host = Request.Headers["X-Original-Host"];
var sitebase = $"{Request.Scheme}://{host}";
var conversationAction = new ConversationAction()
{
Name = CONF_NAME, Record = "true",
EventMethod = "POST",
EventUrl = new string[] { $"{sitebase}/recordconversation/webhooks/recording" }
};
var ncco = new Ncco(conversationAction);
var json = ncco.ToString();
return Ok(json);
}
[HttpPost("webhooks/recording")]
public async Task<IActionResult> Recording()
{
var record = await WebhookParser.ParseWebhookAsync<Record>(Request.Body, Request.ContentType);
Console.WriteLine($"Record event received on webhook - URL: {record?.RecordingUrl}");
return StatusCode(204);
}
Prerequisites
A Vonage application contains the required configuration for your project. You can create an application using the Vonage CLI (see below) or via the dashboard. To learn more about applications see our Vonage concepts guide.
Install the CLI
npm install -g nexmo-cli
Create an application
Once you have the CLI installed you can use it to create a Vonage application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID
in the example below. It will also create private.key
in the current directory which you will need in the Initialize your dependencies step
Vonage needs to connect to your local machine to access your answer_url
. We recommend using ngrok to do this. Make sure to change demo.ngrok.io
in the examples below to your own ngrok URL.
nexmo app:create "Record Conversation Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
composer require slim/slim:^3.8 vonage/client
Create a file named index.php
and add the following code:
use Dotenv\Dotenv;
use Laminas\Diactoros\Response\JsonResponse;
use \Psr\Http\Message\ResponseInterface as Response;
use \Psr\Http\Message\ServerRequestInterface as Request;
Add the following to index.php
:
require 'vendor/autoload.php';
$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();
define('CONF_NAME', getenv('CONF_NAME'));
$app = new \Slim\App();
Write the code
Add the following to index.php
:
$app->map(['GET', 'POST'], '/webhooks/event', function($request, $response) {
error_log(print_r($_REQUEST, true));
});
$app->get('/webhooks/answer', function (Request $request, Response $response) {
//Get our public URL for this route
$uri = $request->getUri();
$url = $uri->getScheme() . '://'.$uri->getHost() . ($uri->getPort() ? ':'.$uri->getPort() : '') . '/webhooks/recordings';
$conversation = new \Vonage\Voice\NCCO\Action\Conversation(CONF_NAME);
$conversation->setRecord(true);
$conversation->setEventWebhook(new \Vonage\Voice\Webhook($url));
$ncco = new \Vonage\Voice\NCCO\NCCO();
$ncco->addAction($conversation);
return new JsonResponse($ncco);
});
$app->post('/webhooks/recordings', function (Request $request, Response $response) {
/** @var \Vonage\Voice\Webhook\Record */
$recording = \Vonage\Voice\Webhook\Factory::createFromRequest($request);
error_log($recording->getRecordingUrl());
return $response->withStatus(204);
});
$app->run();
Run your code
Save this file to your machine and run it:
php index.php
Prerequisites
A Vonage application contains the required configuration for your project. You can create an application using the Vonage CLI (see below) or via the dashboard. To learn more about applications see our Vonage concepts guide.
Install the CLI
npm install -g nexmo-cli
Create an application
Once you have the CLI installed you can use it to create a Vonage application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID
in the example below. It will also create private.key
in the current directory which you will need in the Initialize your dependencies step
Vonage needs to connect to your local machine to access your answer_url
. We recommend using ngrok to do this. Make sure to change demo.ngrok.io
in the examples below to your own ngrok URL.
nexmo app:create "Record Conversation Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
pip install 'flask>=1.0'
Create a file named record-a-conversation.py
and add the following code:
from pprint import pprint
from flask import Flask, request, jsonify
app = Flask(__name__)
Write the code
Add the following to record-a-conversation.py
:
@app.route("/webhooks/answer")
def answer_call():
ncco = [
{
"action": "conversation",
"name": "CONF_NAME",
"record": "true",
"eventMethod": "POST",
"eventUrl": ["https://demo.ngrok.io/webhooks/recordings"]
}
]
return jsonify(ncco)
@app.route("/webhooks/recordings", methods=['POST'])
def recordings():
data = request.get_json()
pprint(data)
return "Webhook received"
Run your code
Save this file to your machine and run it:
python3 record-a-conversation.py
Prerequisites
A Vonage application contains the required configuration for your project. You can create an application using the Vonage CLI (see below) or via the dashboard. To learn more about applications see our Vonage concepts guide.
Install the CLI
npm install -g nexmo-cli
Create an application
Once you have the CLI installed you can use it to create a Vonage application. Run the following command and make a note of the application ID that it returns. This is the value to use in NEXMO_APPLICATION_ID
in the example below. It will also create private.key
in the current directory which you will need in the Initialize your dependencies step
Vonage needs to connect to your local machine to access your answer_url
. We recommend using ngrok to do this. Make sure to change demo.ngrok.io
in the examples below to your own ngrok URL.
nexmo app:create "Record Conversation Example" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key
gem install sinatra sinatra-contrib
Create a file named record-a-conversation.rb
and add the following code:
require 'sinatra'
require 'sinatra/multi_route'
require 'json'
before do
content_type :json
end
helpers do
def parsed_body
JSON.parse(request.body.read)
end
end
Write the code
Add the following to record-a-conversation.rb
:
CONF_NAME = "record-a-conversation"
route :get, :post, '/webhooks/answer' do
[
{
action: "conversation",
name: CONF_NAME,
record: "true",
#This currently needs to be set rather than default due to a known issue https://help.nexmo.com/hc/en-us/articles/360001162687
eventMethod: "POST",
eventUrl: ["#{request.base_url}/webhooks/recordings"]
}
].to_json
end
route :get, :post, '/webhooks/recordings' do
recording_url = params['recording_url'] || parsed_body['recording_url']
puts "Recording URL = #{recording_url}"
halt 204
end
set :port, 3000
Run your code
Save this file to your machine and run it:
ruby record-a-conversation.rb
Try it out
You will need to:
- Record a conversation by dialling your Vonage Number (this code snippet).
- Download the recording. See the Download a recording code snippet for how to do this.