Create recording settings

POST /v1/RecordingSettings/Default
Account sid auth token

Recording settings

application/x-www-form-urlencoded

Body

  • FriendlyName string Required

    A descriptive string that you create to describe the resource and be shown to users in the console

  • AwsCredentialsSid string

    The SID of the stored Credential resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.

  • EncryptionKeySid string

    The SID of the Public Key resource to use for encryption.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.

  • AwsS3Url 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 boolean

    Whether all recordings should be written to the aws_s3_url. When false, all recordings are stored in our cloud.

  • EncryptionEnabled boolean

    Whether all recordings should be stored in an encrypted form. The default is false.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the RecordingSettings resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • friendly_name string | null

      The string that you assigned to describe the resource and show the user in the console

    • aws_credentials_sid string | null

      The SID of the stored Credential resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.

    • aws_s3_url string(uri) | null

      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 boolean | null

      Whether all recordings are written to the aws_s3_url. When false, all recordings are stored in our cloud.

    • encryption_key_sid string | null

      The SID of the Public Key resource used for encryption.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CR[0-9a-fA-F]{32}$.

    • encryption_enabled boolean | null

      Whether all recordings are stored in an encrypted form. The default is false.

    • url string(uri) | null

      The absolute URL of the resource.
POST /v1/RecordingSettings/Default 
curl \
 --request POST 'https://video.twilio.com/v1/RecordingSettings/Default' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'AwsS3Url=https%3A%2F%2Fmy-super-duper-bucket.s3.amazonaws.com%2Fmy%2Fpath%2F&FriendlyName=friendly_name&EncryptionKeySid=CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab&AwsCredentialsSid=CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AwsStorageEnabled=true&EncryptionEnabled=true'
Request example 
{"AwsS3Url"=>"https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "FriendlyName"=>"friendly_name", "EncryptionKeySid"=>"CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", "AwsCredentialsSid"=>"CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "AwsStorageEnabled"=>true, "EncryptionEnabled"=>true}
Response examples (200) 
{
  "url": "https://video.twilio.com/v1/RecordingSettings/Default",
  "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "friendly_name": "friendly_name",
  "encryption_enabled": true,
  "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "aws_storage_enabled": true
}