Fetch composition settings

GET /v1/CompositionSettings/Default

Recording composition settings

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 CompositionSettings 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 that will be shown 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 compositions are 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.

    • aws_storage_enabled boolean | null

      Whether all compositions are written to the aws_s3_url. When false, all compositions 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 compositions are stored in an encrypted form. The default is false.

    • url string(uri) | null

      The absolute URL of the resource.

GET /v1/CompositionSettings/Default
curl \
 --request GET 'https://video.twilio.com/v1/CompositionSettings/Default' \
 --user "username:password"
Response examples (200)
{
  "url": "https://video.twilio.com/v1/CompositionSettings/Default",
  "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "friendly_name": "string",
  "encryption_enabled": true,
  "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "aws_storage_enabled": true
}