Record a named 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
npm install express body-parserWrite the code
Add the following to record-a-conversation.js:
const Express = require('express');
const bodyParser = require('body-parser');
const app = new Express();
app.use(bodyParser.json());
const onInboundCall = (request, response) => {
const ncco = [
{
'action': 'conversation',
'name': VOICE_CONF_NAME,
'record': 'true',
'eventMethod': 'POST',
'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(port, () => {
console.log(`Example app listening on port ${port}`);
});Run your code
Save this file to your machine and run it:
Prerequisites
Add the following to build.gradle:
implementation 'com.vonage:server-sdk-kotlin:2.1.1'
implementation 'io.ktor:ktor-server-netty'
implementation 'io.ktor:ktor-serialization-jackson'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.kt.voice with the package containing RecordConversation:
Prerequisites
Add the following to build.gradle:
implementation 'com.vonage:server-sdk:9.3.1'
implementation 'com.sparkjava:spark-core:2.9.4'Write the code
Add the following to the main method of the RecordConversation file:
/*
* 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(VOICE_CONFERENCE_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(EventWebhook.fromJson(req.body()).getRecordingUrl());
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:
Prerequisites
Install-Package VonagePrerequisites
composer require slim/slim:^3.8 vonage/clientRun your code
Save this file to your machine and run it:
Prerequisites
pip install vonage python-dotenv fastapi[standard]Run your code
Save this file to your machine and run it:
Prerequisites
gem install sinatra sinatra-contribWrite the code
Add the following to record-a-conversation.rb:
require 'sinatra'
require 'sinatra/multi_route'
require 'json'
VOICE_CONFERENCE_NAME = ENV['VOICE_CONFERENCE_NAME']
before do
content_type :json
end
helpers do
def parsed_body
JSON.parse(request.body.read)
end
end
route :get, :post, '/webhooks/answer' do
[
{
action: "conversation",
name: VOICE_CONFERENCE_NAME,
record: "true",
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, 3000Run your code
Save this file to your machine and run it:
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.
Further Reading
- Call Recording - Recording audio input from a caller or recording the conversation between two callers.