メニュー

Expand
Rate this page:

Thanks for rating this page!

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

Encrypted Compositions

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

概要

The Twilio Composition Settings REST API lets you configure Twilio to store your compositions encrypted. Composition Settings work per-account (i.e. project). If you activate encryption, all Video Compositions in your account (or project) will get encrypted.

This document contains reference information about the Composition Settings REST API for encryption. For a step-by-step guide you can also read the Encrypting your Stored Media developer guide

目次

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://<my-bucket>.s3-<aws-region>.amazonaws.com/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.

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

If you have an interest in activating External S3 Storage 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://<my-bucket>.s3-<aws-region>.amazonaws.com/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 External S3 Storage:

        • AwsCredentialsSid
        • AwsS3Url
        • AwsStorageEnabled

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

        Enabling Encrypted Compositions

        The following code snippets illustrate how you can set Encryption in your Compositions settings:

              
              
              
              

              Known Problems and Limitations

              • No known problems.
              Rate this page:

              ヘルプが必要ですか?

              誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。