メニュー

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?

REST API: 録音

概要

Twilio Video’s Group Rooms and Recording APIs enable you to record the audio and video shared in a Programmable Video Room. To turn on Recording in a Group Room, set the RecordParticipantsOnConnect property to true when creating the Room. Check the Rooms REST API documentation for additional information.

全Recordingリソースは下記のベースURLの間に位置しています。

https://video.twilio.com

Legal implications of call recording

If you choose to record voice or video calls, you need to comply with certain laws and regulations, including those regarding obtaining consent to record (such as California’s Invasion of Privacy Act and similar laws in other jurisdictions). Additional information on the legal implications of call recording can be found here.



Notice: Twilio recommends that you consult with your legal counsel to make sure that you are complying with all applicable laws in connection with communications you record or store using Twilio.

BETA


Twilio Video Recordings are currently available as a BETA product. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. BETA products are not covered by a Twilio SLA. See this article for more information on Beta product support.

Names in Java format
accountSid
sid<AC> Not PII

The unique SID identifier of the Twilio Account.

status
enum:status Not PII

Recordingのステータスです。 取りうる値は、processingcompletedもしくはdeletedです。processingは、Recordingがまだ取り込み中であることを示します; completedはRecordingを取り込み終わり、ダウンロード可能になったことを示します。 deletedは録音済みメディアがシステムから削除されたが、履歴を確認できるようメタデータは依然として取得できることを示します。

dateCreated
date_time<iso8601> Not PII

Date conforming to UTC ISO 8601 Timestamp. Matches the time the media recording began writing.

sid
sid<RT> Not PII

RTxx...xx Recordingを一意に識別する、システムによって生成された34文字の文字列です。

sourceSid
sid Not PII

Recordingのソースを識別します。 Room Recordingに対しては、このフィールドには以下が保存されます - TrackSid.

size
long Not PII

録音済みトラックの大きさで、単位はバイトです。

url
url Not PII

このリソースの絶対 URL です。

type
enum:type Not PII

Indicates the media type for this recording. Can be either audio or video.

duration
integer? Not PII

Duration of the Recording in seconds rounded to the nearest second. Thus, sub-second duration tracks have a Duration property of 1 second

containerFormat
enum:format Not PII

Recordingのファイル形式です。 Video Roomの録音はMatroskaコンテナー形式で取り込まれ、オーディオファイルにはmkaが、ビデオファイルにはmkvが設定されます。

codec
enum:codec Not PII

トラックのエンコードに使用されたCodecです。 現時点でサポートされるCodecには、VP8H264OPUS、およびPCMUが含まれます。

groupingSids
オブジェクト Not PII

A list of Sids related to this Recording. Includes the RoomSid and ParticipantSid.

trackName
文字列 PII MTL: 30 DAYS

The name that was given to the source track of this recording. If no name is given, the SourceSid is used.

offset
long Not PII

The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room.

links
uri_map Not PII

Note: The duration of media tracks is rounded to the nearest second. Thus, sub-second duration tracks have a Duration property of 1 second.

HTTP GET

Returns a single Recording Instance resource identified by a RecordingSid.

Example: Retrieve a Recording

        
        
        
        

        HTTP GET to the /Media subresource

        Retrieves the media file associated to a given Recording Instance resource identified by a RecordingSid

        When you make a request to this URL, Twilio will generate a temporary URL for accessing this binary data, and issue an HTTP 302 redirect response to your request. The Recording will be returned in the format as described in the metadata, with the Content-Type header set according to the codec used to record the media

        Codec Content-Type
        VP8 video/webm
        OPUS audio/webm
        PCMU audio/x-matroska
        H264 video/x-matroska

        The URL returned will only be available for 60 minutes, but a different expiration can be specified via the Ttl request param. If the composition is not yet available, a 404 is returned. If the recording is not available (for example, if its status is processing or deleted), an HTTP 404 response is returned.

        The HTTP GET request accepts the following parameters

        名前 概要
        ContentDisposition Optional. Sets the Content-Disposition header of the redirect_to URL. Possible values are attachment or inline. Default value attachment%3B%20filename%3D%22RTxxx.mk{a|v} (not PII)
        Ttl Optional. Duration in seconds for which the redirect_to URL can be used to retrieve the media file. The maximum expiration time is 7 days (604800) (not PII)

        The Content-Disposition header can be set in this request. By default, the value of this header is attachment%3B%20filename%3D%22RTxxx.mk{a|v}.

        NOTE: You can play these recordings in media players that support the Matroska file format, like the VLC player. You can also use other programs like Chrome, ffplay or ffplayer to play these recordings. However, these files are optimized for compactness and they are not player-friendly. Hence, you may experience different types of problems when playing these files. For generating player-friendly media files, compose your Recordings using Twilio's Recordings Composition API.

        Example: Retrieve a Recording's Media

              
              
              
              

              HTTP POST

              サポートされていません。

              HTTP DELETE

              録音メディアファイルを削除します。

              The metadata for the Recording is preserved for a period of 30 days, and its Status is set to deleted. After this period, the metadata will not be available. By default, Recordings with deleted status are not returned when retrieving the Recordings list. To retrieve deleted Recordings, use the Status=deleted filter.

              Note that the 30 day period starts after the Status is set to deleted. After this period expires, the metadata will not be available.

              Example: Delete a Recording

                    
                    
                    
                    

                    Recordings リスト リソース

                    Recordingの一覧は下記URLから利用可能です。

                     /v1/Recordings
                    

                    HTTP GET

                    ページングデータを伴う全Track Recordingの一覧を返します。

                    HTTP GET: リストフィルター

                    The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive.

                    Names in Java format
                    status
                    オプション
                    GET enum:status Not PII

                    Only show Recordings with the given status.

                    sourceSid
                    オプション
                    GET sid Not PII

                    Only show the Recordings with the given source Sid (you can use this to filter Recordings by TrackSid for Video Room Recordings.

                    groupingSid
                    オプション
                    GET sid[] Not PII

                    Only show Recordings that have this GroupingSid, which may include a ParticipantSid and/or a RoomSid.

                    dateCreatedAfter
                    オプション
                    GET date_time<iso8601> Not PII

                    Only show Recordings that started on or after this ISO8601 date-time with timezone, given as YYYY-MM-DDThh:mm:ss+|-hh:mm or YYYY-MM-DDThh:mm:ssZ.

                    dateCreatedBefore
                    オプション
                    GET date_time<iso8601> Not PII

                    Only show Recordings that started before this ISO8601 date-time with timezone, given as YYYY-MM-DDThh:mm:ss+|-hh:mm or YYYY-MM-DDThh:mm:ssZ.

                    mediaType
                    オプション
                    GET enum:type Not PII

                    Only show Recordings that have this media type. Can be either audio or video.

                    Note: deleted Recordings are not returned by default. For retrieving the deleted Recordings list you must explicitly specify Status=deleted.

                    Example: Get all Recordings for a given Room

                          
                          
                          
                          
                                
                                
                                
                                
                                      
                                      
                                      
                                      

                                      HTTP POST

                                      サポートされていません。

                                      HTTP DELETE

                                      サポートされていません。

                                      Rooms APIを使用した、Recordingsの検索

                                      特定のRoomからお客様によるRecordingsの検索を容易にするよう、Rooms APIを通じた一覧のフィルタリングに対して下記のアフォーダンスを提供します:

                                      Example: Get all recordings from a given Room using the Rooms API

                                            
                                            
                                            
                                            
                                                  
                                                  
                                                  
                                                  
                                                        
                                                        
                                                        
                                                        

                                                        Known issues and limitations

                                                        • Recording files are generated with a format optimized for reliability and compactness. This format is not player friendly. Hence, many media players may not render Recordings media files appropriately. For generating player-friendly media files, compose your Recordings using Twilio's Recordings Composition API.
                                                        Rate this page:

                                                        ヘルプが必要ですか?

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