This documentation is for reference only. We are no longer onboarding new customers to Programmable Video. Existing customers can continue to use the product until December 5, 2026.
We recommend migrating your application to the API provided by our preferred video partner, Zoom. We've prepared this migration guide to assist you in minimizing any service disruption.
This feature is only available through Twilio Enterprise Edition or Security Edition. For further information, contact the Twilio sales team.
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
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:
_10https://video.twilio.com/v1/RecordingSettings/Default
A RecordingSettings resource has the following properties:
account_sid
type: SID<AC>The SID of the Account that created the RecordingSettings resource.
^AC[0-9a-fA-F]{32}$
34
34
friendly_name
type: stringThe string that you assigned to describe the resource and show the user in the console
aws_credentials_sid
type: SID<CR>The SID of the stored Credential resource.
^CR[0-9a-fA-F]{32}$
34
34
aws_s3_url
type: string<uri>The URL of the AWS S3 bucket where the recordings are stored. We only support DNS-compliant URLs like https://documentation-example-twilio-bucket/recordings
, where recordings
is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986.
aws_storage_enabled
type: booleanWhether all recordings are written to the aws_s3_url
. When false
, all recordings are stored in our cloud.
encryption_key_sid
type: SID<CR>The SID of the Public Key resource used for encryption.
^CR[0-9a-fA-F]{32}$
34
34
encryption_enabled
type: booleanWhether all recordings are stored in an encrypted form. The default is false
.
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:
Sets your account's default Recording Settings. POST requests support the following parameters:
FriendlyName
type: stringRequiredA descriptive string that you create to describe the resource and be shown to users in the console
AwsCredentialsSid
type: SID<CR>The SID of the stored Credential resource.
^CR[0-9a-fA-F]{32}$
34
34
EncryptionKeySid
type: SID<CR>The SID of the Public Key resource to use for encryption.
^CR[0-9a-fA-F]{32}$
34
34
AwsS3Url
type: string<uri>The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like https://documentation-example-twilio-bucket/recordings
, where recordings
is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986.
AwsStorageEnabled
type: booleanWhether all recordings should be written to the aws_s3_url
. When false
, all recordings are stored in our cloud.
EncryptionEnabled
type: booleanWhether all recordings should be stored in an encrypted form. The default is false
.
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: