Record Phone Calls in Node.js

Expand image

When a phone number you have bought through Twilio receives an incoming call, Twilio will send an HTTP request to a server you control, asking for instructions on how to handle the call. Your server will respond with an XML document containing TwiML that tells Twilio to read out a message, play an MP3 file, make a recording, and much more.

To start answering phone calls, you must:

• Buy and configure a Twilio-powered phone number capable of making and receiving phone calls, and point it at your web application

• Write web application code to tell Twilio how to handle the incoming call (using TwiML)

• Make your web application accessible on the Internet so Twilio can send you a webhook request when you receive a call

In the console, you can search for and buy phone numbers in dozens of different countries, capable of calling (and being called by) just about every phone on the planet.

Expand image

Once you purchase a number, you'll need to configure that number to send a request to your web application. This callback mechanism is called a webhook. This can be done in the number's configuration page.

Expand image

A webhook is a callback mechanism that allows two systems to communicate events to one another over the Internet using HTTP requests. In this case, Twilio is sending a webhook request to your web application whenever a phone number you control receives an incoming call. You'll see this webhook mechanism used in many Twilio APIs for handling event notifications like this.

Not working on a server with a public URL? We'll show you how to expose your local development machine to the public Internet later in this guide. Next, you'll need to write some server-side code that will be executed when an incoming call comes in.

Now comes the fun part - writing code that will handle an incoming HTTP request from Twilio!

In this example we'll use the Express web framework for Node.js to respond to Twilio's request and we'll use TwiML to tell Twilio how to handle the call.

1
const express = require('express');
2
const VoiceResponse = require('twilio').twiml.VoiceResponse;
3

4
const app = express();
5

6
// Returns TwiML which prompts the caller to record a message
7
app.post('/record', (request, response) => {
8
  // Use the Twilio Node.js SDK to build an XML response
9
  const twiml = new VoiceResponse();
10
  twiml.say('Hello. Please leave a message after the beep.');
11

12
  // Use <Record> to record the caller's message
13
  twiml.record();
14

15
  // End the call with <Hangup>
16
  twiml.hangup();
17

18
  // Render the response as XML in reply to the webhook request
19
  response.type('text/xml');
20
  response.send(twiml.toString());
21
});
22

23
// Create an HTTP server and listen for requests on port 3000
24
app.listen(3000);

TwiML is a set of XML tags that tell Twilio how to handle an incoming call (or SMS). In this example we tell Twilio to read some instructions to the caller and then record whatever the caller says next.

You can listen to your recordings in your Twilio Console or access them directly through Twilio's REST API.

You can also tell Twilio to transcribe a recording, giving you a text representation of what the caller said.

1
const express = require('express');
2
const VoiceResponse = require('twilio').twiml.VoiceResponse;
3

4
const app = express();
5

6
// Returns TwiML which prompts the caller to record a message
7
app.post('/record', (request, response) => {
8
  // Use the Twilio Node.js SDK to build an XML response
9
  const twiml = new VoiceResponse();
10
  twiml.say('Hello. Please leave a message after the beep.');
11

12
  // Use <Record> to record and transcribe the caller's message
13
  twiml.record({ transcribe: true, maxLength: 30 });
14

15
  // End the call with <Hangup>
16
  twiml.hangup();
17

18
  // Render the response as XML in reply to the webhook request
19
  response.type('text/xml');
20
  response.send(twiml.toString());
21
});
22

23
// Create an HTTP server and listen for requests on port 3000
24
app.listen(3000);

Here we add "transcribe: true" to our response to tell Twilio to transcribe the recording after it's complete. We also pass a "maxLength" argument to limit the length of the recording (it defaults to an hour).

Check out the <Record> reference docs to see all the parameters you can use to customize your recordings.

When you make outgoing calls with the Twilio REST API, you can tell Twilio to record the entire call from beginning to end.

First, you'll need to get your Twilio account credentials. They can be found on the home page of the console.

Expand image

Just pass an extra "record" argument to "client.calls.create()" and Twilio will record the entire phone call.

1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3

4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9

10
async function createCall() {
11
  const call = await client.calls.create({
12
    from: "+15017122661",
13
    record: true,
14
    to: "+14155551212",
15
    url: "http://demo.twilio.com/docs/voice.xml",
16
  });
17

18
  console.log(call.sid);
19
}
20

21
createCall();

1
{
2
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
  "annotation": null,
4
  "answered_by": null,
5
  "api_version": "2010-04-01",
6
  "caller_name": null,
7
  "date_created": "Tue, 31 Aug 2010 20:36:28 +0000",
8
  "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000",
9
  "direction": "inbound",
10
  "duration": "15",
11
  "end_time": "Tue, 31 Aug 2010 20:36:44 +0000",
12
  "forwarded_from": "+141586753093",
13
  "from": "+15017122661",
14
  "from_formatted": "(415) 867-5308",
15
  "group_sid": null,
16
  "parent_call_sid": null,
17
  "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18
  "price": "-0.03000",
19
  "price_unit": "USD",
20
  "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
21
  "start_time": "Tue, 31 Aug 2010 20:36:29 +0000",
22
  "status": "completed",
23
  "subresource_uris": {
24
    "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json",
25
    "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json",
26
    "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json",
27
    "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json",
28
    "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json",
29
    "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json",
30
    "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json",
31
    "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json",
32
    "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json"
33
  },
34
  "to": "+14155551212",
35
  "to_formatted": "(415) 867-5309",
36
  "trunk_sid": null,
37
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
38
  "queue_time": "1000"
39
}

Once the call is complete, you can listen to your recordings in your Twilio Console or access them directly through Twilio's REST API.

You can also gain access to the recording as soon as the call is complete by including a recordingStatusCallback with your client.calls.create method. When your recording is ready, Twilio will send a request to the URL you specified, and that request will include a link to the recording's audio file.

You can learn more about the RecordingStatusCallback parameter in the Call Resource API documentation.

If this guide was helpful, you might also want to check out these tutorials for Programmable Voice and Node.js. Tutorials walk through full sample applications, implementing Twilio use cases like these:

• Automated phone surveys
• Call tracking and lead attribution
• Click to call

Happy hacking!