Encrypted Recordings

The Twilio Recording Settings REST API lets you configure Twilio to store your recordings encrypted. Recording Settings work per-account (i.e. project). If you activate encryption, all Video Recordings in your account (or project) will get encrypted.

This document contains reference information about the Recording Settings REST API for encryption. For a step-by-step guide you can also read the Encrypting your Stored Media developer guide

• URI Schemes
• Recording Settings instance resource
  • Base URL
  • Resource Properties
  • HTTP GET: Get Settings
  • HTTP POST: Set Settings
    • Enabling Encrypted Recordings
• Known Problems and Limitations

These are the URI schemes for the Recording Settings REST API and the supported methods:

• /v1/RecordingSettings/Default
  • GET: Retrieves current Recording Settings.
  • POST: Updates the Recording Settings.

The Default RecordingSettings resource holds the default recording settings for the given Twilio account (or project). Its configuration will be applied to all Recordings created in such account (or project).

The Recording Settings default resource is located at the following Base URL:

1
https://video.twilio.com/v1/RecordingSettings/Default
2

A RecordingSettings resource has the following properties:

In the table above, the following properties are reserved for the feature called External S3 Storage:

• aws_credentials_sid
• aws_s3_url
• aws_storage_enabled

Retrieves your account's default Recording Settings.

For example:

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 fetchRecordingSettings() {
11
  const recordingSetting = await client.video.recordingSettings().fetch();
12

13
  console.log(recordingSetting.accountSid);
14
}
15

16
fetchRecordingSettings();

1
{
2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3
  "friendly_name": "string",
4
  "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5
  "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6
  "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",
7
  "aws_storage_enabled": true,
8
  "encryption_enabled": true,
9
  "url": "https://video.twilio.com/v1/RecordingSettings/Default"
10
}

Sets your account's default Recording Settings. POST requests support the following parameters:

{
  "FriendlyName": "friendly_name",
  "AwsCredentialsSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "EncryptionKeySid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
  "AwsS3Url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",
  "AwsStorageEnabled": true,
  "EncryptionEnabled": true
}

In the table above, the following parameters are reserved for the feature called External S3 Storage:

• AwsCredentialsSid
• AwsS3Url
• AwsStorageEnabled

The following code snippets illustrate how you can set Encryption in your Recordings settings:

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 createRecordingSettings() {
11
  const recordingSetting = await client.video.recordingSettings().create({
12
    encryptionEnabled: true,
13
    encryptionKeySid: "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
14
    friendlyName: "Upload encrypted",
15
  });
16

17
  console.log(recordingSetting.accountSid);
18
}
19

20
createRecordingSettings();

1
{
2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3
  "friendly_name": "Upload encrypted",
4
  "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5
  "encryption_key_sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
6
  "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",
7
  "aws_storage_enabled": true,
8
  "encryption_enabled": true,
9
  "url": "https://video.twilio.com/v1/RecordingSettings/Default"
10
}

• If you activate Encryption in your account, you will not be able to use Compositions in such account given that Compositions require the source recordings to be stored unencrypted.