Create composition settings

POST /v1/CompositionSettings/Default

Recording composition settings

Body

  • 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}$.

  • AwsS3Url string(uri)

    The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like https://documentation-example-twilio-bucket/compositions, where compositions is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986.

  • AwsStorageEnabled boolean

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

  • EncryptionEnabled boolean

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

  • 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}$.

  • FriendlyName string Required

    A descriptive string that you create to describe the resource and show to the user in the console

Responses

  • 201

    Created

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

      The SID of the Account that created the resource

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

    • 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 compositions are stored

    • aws_storage_enabled boolean | null

      Whether all compositions are written to the aws_s3_url

    • encryption_enabled boolean | null

      Whether all compositions are stored in an encrypted form

    • 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}$.

    • friendly_name string | null

      The string that you assigned to describe the resource

    • url string(uri) | null

      The absolute URL of the resource
POST /v1/CompositionSettings/Default 
curl \
 -X POST https://video.twilio.com/v1/CompositionSettings/Default \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'AwsCredentialsSid=string&AwsS3Url=https%3A%2F%2Fexample.com&AwsStorageEnabled=true&EncryptionEnabled=true&EncryptionKeySid=string&FriendlyName=string'
Request example 
{
  "AwsCredentialsSid": "string",
  "AwsS3Url": "https://example.com",
  "AwsStorageEnabled": true,
  "EncryptionEnabled": true,
  "EncryptionKeySid": "string",
  "FriendlyName": "string"
}
Request examples 
{
  "AwsCredentialsSid": "string",
  "AwsS3Url": "https://example.com",
  "AwsStorageEnabled": true,
  "EncryptionEnabled": true,
  "EncryptionKeySid": "string",
  "FriendlyName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "aws_credentials_sid": "string",
  "aws_s3_url": "https://example.com",
  "aws_storage_enabled": true,
  "encryption_enabled": true,
  "encryption_key_sid": "string",
  "friendly_name": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "aws_credentials_sid": "string",
  "aws_s3_url": "https://example.com",
  "aws_storage_enabled": true,
  "encryption_enabled": true,
  "encryption_key_sid": "string",
  "friendly_name": "string",
  "url": "https://example.com"
}