メニュー

Expand
ページを評価:

External S3 Compositions

This feature is available in Twilio Enterprise Edition and Security Edition. For further information contact the Twilio sales team.

目次

URI Schemes

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

  • /v1/CompositionSettings/Default
    • GET: Retrieves current Composition Settings.
    • POST: Updates the Composition Settings.

Composition Settings instance resource

The Default CompositionSettings resource holds the default composition settings for the given Twilio account (or project). Its configuration will be applied to all Recording Compositions created in such account (or project).

ベースURL

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

https://video.twilio.com/v1/CompositionSettings/Default

リソースのプロパティ

A CompositionSettings resource has the following properties:

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the CompositionSettings resource.

friendly_name
文字列 Not PII

The string that you assigned to describe the resource and that will be shown in the console

aws_credentials_sid
sid<CR> Not PII

The SID of the stored Credential resource.

aws_s3_url
url Not PII

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 Not PII

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

encryption_key_sid
sid<CR> Not PII

The SID of the Public Key resource used for encryption.

encryption_enabled
boolean Not PII

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

url
url Not PII

The absolute URL of the resource.

概要

The Twilio Composition Settings REST API lets you configure Twilio to store your compositions in an external AWS S3 bucket. Composition Settings work per-account (i.e. project). If you activate external S3 storage all Video Compositions in your account (or project) will be stored in the specified external bucket.

This document contains reference information about the Composition Settings REST API for external S3 storage. For a step-by-step guide you can also read the Storing into AWS S3 developer guide

In the table above, the following properties are reserved for the feature called Encrypted Compositions:

  • encryption_key_sid
  • encryption_enabled

If you have an interest in activating Encrypted Compositions in you account, please contact the Twilio Support Service.

HTTP GET: Get Settings

Retrieves your account's default Composition Settings.

たとえば、次のようになります。

        
        
        

        HTTP POST: Set Settings

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

        Parameters in REST API format
        friendly_name
        必須
        post 文字列 Not PII

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

        aws_credentials_sid
        オプション
        post sid<CR> Not PII

        The SID of the stored Credential resource.

        encryption_key_sid
        オプション
        post sid<CR> Not PII

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

        aws_s3_url
        オプション
        post url Not PII

        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.

        aws_storage_enabled
        オプション
        post boolean Not PII

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

        encryption_enabled
        オプション
        post boolean Not PII

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

        In the table above, the following parameters are reserved for the feature called Encrypted Compositions:

        • EncryptionKeySid
        • EncryptionEnabled

        If you have an interest in activating Encrypted Compositions and enable the use of these parameters in you account, please contact the Twilio Support Service.

        Enabling external S3 storage for Compositions

        The following code snippet illustrate how you can set your Compositions to be stored in an external S3 bucket:

              
              
              

              Disabling external S3 storage for Compositions

              To stop storing compositions in an AWS S3 Bucket by default, you can create a new default configuration with AWS storage disabled. If you disable external AWS S3 storage, compositions will be stored in the Twilio cloud.

                    
                    
                    
                    ページを評価:

                    ヘルプが必要ですか?

                    We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.

                          
                          
                          

                          フィードバックくださりありがとうございます!

                          We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                          Sending your feedback...
                          🎉 Thank you for your feedback!
                          Something went wrong. Please try again.

                          Thanks for your feedback!

                          Refer us and get $10 in 3 simple steps!

                          ステップ1

                          Get link

                          Get a free personal referral link here

                          ステップ2:

                          Give $10

                          Your user signs up and upgrade using link

                          ステップ3

                          Get $10

                          1,250 free SMSes
                          OR 1,000 free voice mins
                          OR 12,000 chats
                          OR more