コンテンツにスキップ
Documentation

RTCの「Bring Your Own Storage(BYOS)」

RTCは、完了したすべての録画を、お客様が所有するバケットにコピーすることができます。また、RTC側でも 独自のコピーを保持CHAMPREPするため、配信の成否にかかわらず、 RTCから録画をダウンロードし続けることができます。

ご自身のストレージへの配信は、 Growth および ビジネス ティア。無料トライアル、Starterティア、および有料 CHAMPREPプランに含まれる割り当てには、これに含まれていません。これがない場合、ストレージルートは 403 RTC_FEATURE_NOT_IN_PLAN ティア に含まれる offers。詳細については、 プランおよび課金.

ご利用のプランから対象が除外された場合、RTCは宛先を無効にします。再度 プランをアップグレードした後、各宛先を再度有効にしてください。RTCはまず新しいテスト書き込みを実行します。

宛先の種類を選択してください

Section titled “宛先の種類を選択してください”
タイプ以下の用途にご利用くださいRTCが保持する内容
aws-role (推奨)AWS S3バケット機密情報は一切含まれていません。RTCでは、外部IDを持つ、お客様が作成したIAMロールを前提としています。
s3-compatibleCloudflare R2、MinIO、Wasabi、Backblaze B2、またはアクセスキーを使用したAWS暗号化されたアクセスキーIDとシークレットキー

デスティネーションはお客様の組織に属します。1つのプロジェクト、またはすべての プロジェクトに対応します。 projectId は null。1つの組織につき最大5つの 宛先を持つことができます。さらに1つ追加すると、回答が得られます 409 DESTINATION_LIMIT.

RTCコンソール、または [API] を通じてAPI、 ログイン済みのコンソールセッション。キーAPIでは、デスティネーションの作成や 変更はできません。権限を持つキーでは recordings:read それらを一覧表示できます。プロジェクトキーは、 自身のプロジェクトの宛先およびすべてのプロジェクトの宛先を確認できます。

メソッドとパス認証情報結果
GET /v1/storage/destinationsコンソールセッション、または recordings:read宛先(古い順)
GET /v1/storage/destinations/{destinationId}コンソールセッション、または recordings:read1つの宛先
GET /v1/storage/aws-setupコンソール セッションお客様の外部 ID および貼り付ける IAM ポリシー(AWSロール)
POST /v1/storage/destinationsコンソール セッション201、テスト書き込み後の宛先
PATCH /v1/storage/destinations/{destinationId}コンソール セッション設定の変更、キーのローテーション、または有効化・無効化を行ってください
POST /v1/storage/destinations/{destinationId}/testコンソール セッションtest-writeを再度実行します
DELETE /v1/storage/destinations/{destinationId}コンソール セッション{ "id": "…", "deleted": true }
GET /v1/recordings/{recordingId}/deliveriesrecordings:read録画データの配信(配信状況を追跡する)
POST /v1/recordings/{recordingId}/redeliverrecordings:write202、録画データを再度配信します
DELETE /v1/recordings/{recordingId}recordings:write録画データをゴミ箱に送信します(録音の削除)
GET /v1/recordings?trashed=truerecordings:readゴミ箱内の録画
POST /v1/recordings/{recordingId}/restorerecordings:writeゴミ箱から記録を取り出す
POST /v1/recordings/{recordingId}/purgerecordings:writeゴミ箱から録画データを完全に削除します

認証情報は決して返されません。応答は Cache-Control: no-store.

フィールド両方のタイプNotes
type✓aws-role または s3-compatible
name✓ラベル(最大80文字)
projectId✓1つのプロジェクト、または null すべてのプロジェクトについて
bucket, region✓バケット名とそのリージョン
pathTemplate✓オプション:詳細については、以下をご覧ください。 パステンプレート
keepCopyDays✓オプション:0~3650、デフォルトは7です。詳細は 保存期間
roleArn, kmsKeyIdaws-roleご自身のロール、および必要に応じて SSE-KMS 用の KMS キー
provider, endpoint, forcePathStyle, accessKeyId, secretAccessKeys3-compatibleforcePathStyle デフォルトでは true

宛先もその情報を報告します。 status (active, unverified または disabled), lastCheck (最新のテスト書き込み)および lastDelivery.

RTCはお客様のAWSキーを一切保持いたしません。お客様はご自身のアカウント内で、RTCの 配信ロールが引き継ぐことができるロールを作成していただきます。このロールは、お客様の 組織に固有の外部IDによって制限されます。

  1. 呼び出し GET /v1/storage/aws-setup?bucket=<your-bucket> (追加 pathTemplate および kmsKeyArn (それらを使用する場合は追加してください)、または コンソールで同じ設定を開いてください。
  2. IAMロールを作成します。返されたを貼り付けます。 trustPolicy:これは信頼します principalArn リクエストにあなたの が含まれている場合のみ externalId.
  3. 返されたをアタッチします。 permissionsPolicy。これにより、 s3:PutObject および s3:AbortMultipartUpload 指定されたパス下で、 s3:DeleteObject 「 検証フォルダ」でのみ、および kms:GenerateDataKey および kms:Encrypt KMS キーを指定したにもかかわらず、応答がありません。
  4. 以下のコマンドで宛先を作成してください: type: "aws-role" 、およびロールの roleArn:
{
"type": "aws-role",
"name": "Recordings archive",
"projectId": null,
"bucket": "acme-rtc-recordings",
"region": "us-east-1",
"roleArn": "<your-delivery-role-arn>"
}

外部 ID は組織ごとに一度作成され、変更されることはありません。 とき available は false セットアップの回答において、AWS ロールの宛先は まだ利用できず、作成すると次のように応答します 503 DELIVERY_NOT_CONFIGURED; その間はアクセス キーをご利用ください。

キーを使用した S3 互換ストレージ

Section titled “キーを使用した S3 互換ストレージ”

使用 type: "s3-compatible" Cloudflare R2、MinIO、Wasabi、Backblaze B2、または アクセスキーをご希望の場合のAWSには、この設定がありません。フィールドにサービスの名前を指定し、 provider フィールドには、 以下のいずれかの値が設定されていません: r2, minio, wasabi, backblaze, aws または other.

  • endpoint ポート 443 上の HTTPS オリジンでなければならず、パス、クエリ、ユーザー 名は含まれず、ドメインCHAMPREP外であり、かつパブリックアドレスに解決される必要があります。RTC は接続のたびにアドレスを再確認します。そうでない場合、RTC は 400 ENDPOINT_NOT_ALLOWED.
  • キーにバケットへの書き込みアクセス権を付与してください。 champrep-rtc-validation/ フォルダを指定すると、RTCはそのテストオブジェクトを削除できます。
  • キーは保存時に暗号化され、決して返されることはありません。宛先には以下の情報のみが表示されます: accessKeyIdHint、キー ID の最後の 4 文字。
  • キーをローテーションするには、 PATCH accessKeyId および secretAccessKey これらすべてが該当します。
  • キーの保存が利用できない場合、RTCは次のように応答します 503 CREDENTIALS_UNAVAILABLE; その間は、AWS ロールをご利用ください。

RTC は、宛先を作成したとき、リージョン、 パステンプレート、ロール、KMS キー、エンドポイント、パススタイル、またはキーを変更したとき、 再度有効にしたとき、および呼び出しを行ったときに、宛先をテストします。 POST /v1/storage/destinations/{destinationId}/test.

このテストでは、64 バイトのオブジェクトを <path prefix>/champrep-rtc-validation/<uuid>.txt その後、そのオブジェクトは削除されます。 削除が拒否された場合は警告に過ぎません:許可 s3:DeleteObject そのフォルダへの書き込みを許可するか、 ご自身でオブジェクトを削除してください。

テストが失敗した場合、宛先は次のように保存されます unverified 、そして 何も受け取りません。 lastCheck にはコードとメッセージが含まれています:

コード意味
ROLE_ASSUME_DENIEDRTC がロールを引き継げませんでした(信頼ポリシーまたは外部 ID)
WRITE_DENIED書き込みが拒否されました
BUCKET_NOT_FOUNDバケットが存在しません
WRONG_REGIONバケットが別のリージョンにあります
INVALID_ACCESS_KEY, INVALID_SECRET_KEYキーが拒否されました
KMS_DENIEDKMSキーによる暗号化が拒否されました
ENDPOINT_NOT_ALLOWED, ENDPOINT_NOT_FOUND, ENDPOINT_UNREACHABLEエンドポイントが拒否された、不明、または応答がありません
DELIVERY_NOT_CONFIGUREDAWSロール宛先は、現時点ではご利用いただけません
STORAGE_ERROR別の保存エラー

原因を修正してから、再度テストを行ってください。宛先は active テストが 成功した際。サポートCHAMPREPによって無効化された送信先は、 ご自身では再有効化できません (DESTINATION_ADMIN_DISABLED).

テンプレートは、各ファイルのオブジェクトキーを設定します。デフォルトは以下の通りです:

{project}/{yyyy}/{mm}/{dd}/{room}/{recording_id}/{file}
変数値
{project}プロジェクトID
{room}ルームID
{recording_id}録音ID
{external_ref}その部屋の externalRef; none それが存在しない場合や異常な場合
{track_id}トラックID
{artifact}録音のどのファイルを
{file}<trackId>.mkv, recording.mp4, audio.m4a、または 文字起こし transcript.json および transcript.vtt
{yyyy}, {mm}, {dd}日付の構成要素

エイリアス project_id, projectId, room_id, roomId, recordingId, externalRef および trackId も受け付けられます。

テンプレートには以下を含める必要があります {recording_id} で終わり、 {file}。リテラルテキストには 文字、数字、および ! _ . * ' ( ) / -。以下で開始することはできません。 / または 含まれる //, . または .. フォルダ。キーの最大サイズは900バイトです。

  • 録音が ready、RTCは、そのファイル(すべてのトラック、および コンポジットファイルがある場合はそれら)を、その プロジェクトの各アクティブな送信先にコピーします。完成した 文字起こし は、と同様に配信されます。 transcript.json および transcript.vtt.
  • 宛先がアクティブになった後に終了した録音のみが 自動的に配信されます。それより前の録音については、 redeliver.
  • 16 MiBを超えるファイルは分割して送信されます。RTCは、送信したバイトの SHA-256ハッシュ値を報告します。
  • 配信に失敗した場合は、72時間にわたりバックオフ(1、2、4…分、最大 1時間間隔)を適用して再試行されます。その後、配信は失敗となり、 recording.delivery_failed 送信されます。
  • 配信されたバイト数は、ご利用のプランのダウンロード容量にカウントされます。
  • 送信先を無効にすると、その送信待ちの配信がキャンセルされます。削除しても 同様に処理され、その認証情報も破棄されます。

アップロードの途中で停止したワーカーは、バケット内に未完了の部分を残す可能性があります。 追加してください。 AbortIncompleteMultipartUpload ライフサイクルルール(1日)を バケットに適用します。

購読するには Webhookエンドポイント これらのイベントについて。各ファイルの 配信ごとに、個別のイベントが送信されます。

イベントdata
recording.deliveredrecordingId, roomId, destinationId, artifact, trackId (トラックの場合)、 bucket, key, size, sha256, checksum, etag, deliveredAt
recording.delivery_failedrecordingId, roomId, destinationId, artifact, trackId (トラックの場合)、 bucket, key, attempts, error (code, message)

録画には配信概要が付随します: delivery.state (pending, delivered, partial または failed)および pending, delivered そして failed がカウントされます。

GET /v1/recordings/{recordingId}/deliveries 戻る recordingId、つまり summary そして deliveries:各ジョブについて、対象のバケットとキー、 結果(サイズ、SHA-256、ETag)、および最後のエラーが表示されます。

POST /v1/recordings/{recordingId}/redeliver オプションとして { "destinationId": "…" } 失敗、キャンセル、および配信済みのジョブを、 新たな72時間の期間で再実行し、欠落しているジョブを作成します。

HTTPコード意味
409RECORDING_NOT_READYのみが ready 録画は配信可能です
409NO_ACTIVE_DESTINATIONこの録画には、有効な保存先が設定されていません
404NO_ACTIVE_DESTINATIONアクティブな宛先にはこれがない destinationId

録画を削除すると、ゴミ箱へ移動します。30日後に自動削除されますが、 それまでは復元が可能です。以下の各コマンドでは、キーが必要です。 recordings:write または、コンソールセッション。

DELETE /v1/recordings/{recordingId} 録画をゴミ箱に送ります:

{ "id": "…", "status": "trashed", "trashedAt": "2026-11-08T12:00:00.000Z", "reason": "customer", "purgeAt": "2026-12-08T12:00:00.000Z" }
  • 録画はリストから削除され、 GET /v1/recordings/{recordingId}. GET /v1/recordings?trashed=true ゴミ箱内の録画一覧が表示されます。
  • ダウンロード機能が停止します。これには、すでに発行されたダウンロードリンクも含まれます。
  • キューに登録されていた配信はキャンセルされます。
  • ゴミ箱にある間は、引き続き録画の保存容量にカウントされ、 課金対象となります。
  • purgeAt 自動削除されるのは、ゴミ箱に送られてから30日後です。 これは、録画がゴミ箱に送られた時点で確定します。その後、 ゴミ箱ウィンドウの設定を変更しても、その変更は、それ以降にゴミ箱に送られた録画にのみ適用されます。 purgeAt は null 一方、ゴミ箱への自動削除は無効になっています。
  • recording.deleted が送信されます。
  • まだ実行中または処理中のレコーディングは、次のように応答します 409 RECORDING_ACTIVE; 処理を停止するか、待機してください。

POST /v1/recordings/{recordingId}/restore は、ゴミ箱から録音データを復元します。 回答は録音データそのものであり、削除される前と同様に、リストやダウンロードに 戻ります。 recording.restored が送信されます。 自動削除または完全削除されるまで、記録を復元することができます。復元が 遅すぎると、応答は 409 RECORDING_PURGED.

録画が「ゴミ箱」に移動した際にキャンセルされた、ご自身のストレージへの配信は 再送信されます。復元された録画は、再度削除されるまで保持されます: 保持機能によって「ゴミ箱」に戻されることはありません。

POST /v1/recordings/{recordingId}/purge は、ゴミ箱内の記録を 完全に削除します。RTCはこれを即座に受理し、応答を返します。 202; 削除は まもなく完了します:

{ "id": "…", "status": "deleting", "purgeRequestedAt": "2026-11-08T12:05:00.000Z" }
  • RTCがリクエストを受け付けた時点から、これを復元することは決してできません。
  • 削除が完了すると、そのファイルは消去され、 記録ストレージの容量計算対象から外れ、 recording.purged が 送信されます。
  • リクエストを繰り返し送信しても問題ありません。応答は 202 削除処理が 実行されている間、再度 200 完了したら: { "id": "…", "status": "purged", "purgedAt": "2026-11-08T12:05:30.000Z" }.
  • ゴミ箱内の記録のみを完全に削除できます。それ以外の記録は 応答します 409 RECORDING_NOT_IN_TRASH: まず「ゴミ箱」へ送ってください。

記録は、その purgeAt (ゴミ箱に30日間保存)、 同様に、そして recording.purged は、 reason: "expired". CHAMPREP サポートチームは、ご要望に応じて、ゴミ箱内の記録を早期に削除することも可能です。

バケットにすでに配信されたコピーは、お客様の所有物となります。記録を ゴミ箱に送ったり、完全に削除したり、自動削除を設定したりしても、それらは削除されません。

CHAMPREP は、プランの保存期間に合わせて記録のコピーを保持します:トライアル版では7日間、 Starter版では30日間、Growth版では90日間、Business版では365日間です。 その期間が経過すると、記録は上記と同様の方法で ゴミ箱へ移動され、 reason: "retention":30日間は復元が可能ですが、 それ以降は自動的に削除されます。

保持期間は、RTCがこれを適用し始めた後に作成された記録にのみ適用されます。 それ以前に作成された記録は、この機能によって期限切れにはなりません。保持期間は、 ご自身のバケット内のコピーには一切影響しません。

keepCopyDays 宛先(0~3650、デフォルトは7)の 設定は、配信後にそのコピーを どのくらいの期間保持したいCHAMPREPかを記録します。CHAMPREP本日のコピーは プランの保持期間に従います。この設定によって、それより早く削除されることはありません。