Zum Inhalt springen
Documentation

RTC „Bring Your Own Storage“

RTC kann jede fertige Aufzeichnung in einen Bucket kopieren, dessen Eigentümer Sie sind. CHAMPREP behält zudem eine eigene Kopie, sodass die Aufzeichnung weiterhin von RTC heruntergeladen werden kann, unabhängig davon, ob die Übertragung erfolgreich ist oder nicht.

Die Bereitstellung in Ihren eigenen Speicher ist im Wachstum und Business Stufen. Die kostenlose Testversion, die Starter-Stufe und das in den kostenpflichtigen CHAMPREP Tarifen enthaltene Kontingent umfassen dies nicht. Ohne diese Funktion antworten die Speicherrouten 403 RTC_FEATURE_NOT_IN_PLAN mit den Speicherebenen, die es enthalten, in offers. Siehe Pläne und Abrechnung.

Sollte Ihr Tarif dieses Feature nicht mehr enthalten, deaktiviert RTC Ihre Ziele. Nachdem Sie erneut ein Upgrade durchgeführt haben, aktivieren Sie jedes Ziel wieder; RTC führt zunächst einen neuen Testschreibvorgang durch.

TypVerwenden Sie es fürWas RTC speichert
aws-role (bevorzugt)Ein AWS-S3-BucketNichts Vertrauliches. RTC geht von einer von Ihnen erstellten IAM-Rolle mit einer externen ID aus.
s3-compatibleCloudflare R2, MinIO, Wasabi, Backblaze B2 oder AWS mit ZugriffsschlüsselnIhre Zugriffsschlüssel-ID und Ihr geheimer Schlüssel, verschlüsselt

Ein Ziel gehört zu Ihrer Organisation. Es dient einem Projekt oder allen Projekten, wenn projectId ist null. Eine Organisation kann bis zu 5 Ziele haben; eine weitere Antwort 409 DESTINATION_LIMIT.

Erstellen, ändern, testen und entfernen Sie Ziele in der RTC-Konsole oder über die API mit Ihrer angemeldete Konsolensitzung. API Schlüssel können keine Ziele erstellen oder ändern. Ein Schlüssel mit recordings:read kann diese auflisten; ein Projektschlüssel sieht die Ziele seines eigenen Projekts sowie die aller Projekte.

Methode und PfadAnmeldeinformationenErgebnis
GET /v1/storage/destinationsKonsolensitzung oder ein Schlüssel mit recordings:readDie Ziele, beginnend mit dem ältesten
GET /v1/storage/destinations/{destinationId}Konsolensitzung oder ein Schlüssel mit recordings:readEin Ziel
GET /v1/storage/aws-setupKonsolensitzungIhre externe ID und die einzufügenden IAM-Richtlinien (AWS-Rolle)
POST /v1/storage/destinationsKonsolensitzung201, das Ziel nach dem Testschreibvorgang
PATCH /v1/storage/destinations/{destinationId}KonsolensitzungÄndern Sie Einstellungen, rotieren Sie Schlüssel oder schalten Sie die Funktion ein bzw. aus
POST /v1/storage/destinations/{destinationId}/testKonsolensitzungFühren Sie den Test-Write erneut aus
DELETE /v1/storage/destinations/{destinationId}Konsolensitzung{ "id": "…", "deleted": true }
GET /v1/recordings/{recordingId}/deliveriesrecordings:readDie Auslieferungen der Aufzeichnung (Lieferungen verfolgen)
POST /v1/recordings/{recordingId}/redeliverrecordings:write202, liefert die Aufzeichnung erneut
DELETE /v1/recordings/{recordingId}recordings:writeSendet die Aufzeichnung in den Papierkorb (Eine Aufzeichnung löschen)
GET /v1/recordings?trashed=truerecordings:readDie Aufzeichnungen im Papierkorb
POST /v1/recordings/{recordingId}/restorerecordings:writeEntnehmen Sie die Aufzeichnung aus dem Papierkorb
POST /v1/recordings/{recordingId}/purgerecordings:writeLöscht die Aufzeichnung endgültig aus dem Papierkorb

Anmeldedaten werden niemals zurückgegeben. Antworten werden gesendet mit Cache-Control: no-store.

FeldBeide TypenNotes
type✓aws-role oder s3-compatible
name✓Ihre Bezeichnung, bis zu 80 Zeichen
projectId✓Ein Projekt oder null für jedes Projekt
bucket, region✓Der Bucket-Name und die zugehörige Region
pathTemplate✓Optional; siehe Pfadvorlagen
keepCopyDays✓Optional, 0 bis 3650, Standardwert 7; siehe Aufbewahrungsfrist
roleArn, kmsKeyIdaws-roleIhre Rolle und optional Ihren KMS-Schlüssel für SSE-KMS
provider, endpoint, forcePathStyle, accessKeyId, secretAccessKeys3-compatibleforcePathStyle Standardmäßig ist true

Ein Ziel meldet außerdem seine status (active, unverified oder disabled), lastCheck (der letzte Test-Schreibvorgang) und lastDelivery.

RTC speichert Ihre AWS-Schlüssel niemals. Sie erstellen in Ihrem Konto eine Rolle, die die Zustellungsrolle von RTC übernehmen kann, begrenzt durch eine externe ID, die für Ihre Organisation eindeutig ist.

  1. Rufen Sie GET /v1/storage/aws-setup?bucket=<your-bucket> (Hinzufügen pathTemplate und kmsKeyArn (falls Sie diese verwenden) oder öffnen Sie dieselbe Konfiguration in der Konsole.
  2. Erstellen Sie eine IAM-Rolle. Fügen Sie den zurückgegebenen Code ein trustPolicy: Sie wird nur vertrauenswürdig principalArn nur, wenn die Anfrage Ihre externalId.
  3. Fügen Sie die zurückgegebene permissionsPolicy. Sie erlaubt s3:PutObject und s3:AbortMultipartUpload unter Ihrem Pfad, s3:DeleteObject nur im Validierungsordner und kms:GenerateDataKey und kms:Encrypt auf Ihren KMS-Schlüssel, sofern Sie einen angegeben haben.
  4. Erstellen Sie das Ziel mit type: "aws-role" und die Rolle roleArn:
{
"type": "aws-role",
"name": "Recordings archive",
"projectId": null,
"bucket": "acme-rtc-recordings",
"region": "us-east-1",
"roleArn": "<your-delivery-role-arn>"
}

Die externe ID wird einmalig für Ihre Organisation erstellt und ändert sich nicht. Wenn available ist false In der Einrichtungsantwort sind AWS-Rollen-Ziele noch nicht verfügbar, und die Erstellung eines solchen Ziels führt zu folgender Antwort: 503 DELIVERY_NOT_CONFIGURED; verwenden Sie in der Zwischenzeit Zugriffsschlüssel.

Verwenden type: "s3-compatible" für Cloudflare R2, MinIO, Wasabi, Backblaze B2 oder AWS, wenn Sie Zugriffsschlüssel bevorzugen. Geben Sie den Namen Ihres Dienstes im provider Feld mit einem der folgenden Werte: r2, minio, wasabi, backblaze, aws oder other.

  • endpoint Es muss sich um eine HTTPS-Quelle auf Port 443 handeln, ohne Pfad, Abfrage oder Benutzernamen, außerhalb von DomänenCHAMPREP, und sie muss auf öffentliche Adressen aufgelöst werden. RTC überprüft die Adresse bei jeder Verbindung erneut. Andernfalls antwortet RTC 400 ENDPOINT_NOT_ALLOWED.
  • Erteilen Sie den Schlüsseln Schreibzugriff auf den Bucket. Entziehen Sie den Zugriff auf den champrep-rtc-validation/ Der Ordner ermöglicht es RTC, sein Testobjekt zu entfernen.
  • Schlüssel werden im Ruhezustand verschlüsselt und niemals zurückgegeben. Ein Ziel zeigt lediglich accessKeyIdHint, die letzten vier Zeichen der Schlüssel-ID.
  • Um Schlüssel zu rotieren, PATCH accessKeyId und secretAccessKey zusammen.
  • Wenn das Speichern von Schlüsseln nicht möglich ist, antwortet RTC 503 CREDENTIALS_UNAVAILABLE; verwenden Sie in der Zwischenzeit eine AWS-Rolle. Rolle.

RTC prüft ein Ziel, wenn Sie es erstellen, wenn Sie dessen Region, Pfadvorlage, Rolle, KMS-Schlüssel, Endpunkt, Pfadstil oder Schlüssel ändern, wenn Sie es wieder aktivieren und wenn Sie POST /v1/storage/destinations/{destinationId}/test.

Der Test schreibt ein 64-Byte-Objekt in <path prefix>/champrep-rtc-validation/<uuid>.txt und entfernt es anschließend. Eine abgelehnte Entfernung ist lediglich eine Warnung: Zulassen s3:DeleteObject in diesem Ordner, oder löschen Sie das Objekt selbst.

Wenn der Test fehlschlägt, wird das Ziel wie folgt gespeichert: unverified und erhält nichts. lastCheck enthält einen Code und einen Satz:

CodeBedeutung
ROLE_ASSUME_DENIEDRTC konnte die Rolle nicht übernehmen (Vertrauensrichtlinie oder externe ID)
WRITE_DENIEDDer Schreibvorgang wurde abgelehnt
BUCKET_NOT_FOUNDDer Bucket existiert nicht
WRONG_REGIONDer Bucket befindet sich in einer anderen Region
INVALID_ACCESS_KEY, INVALID_SECRET_KEYDie Schlüssel wurden abgelehnt
KMS_DENIEDDer KMS-Schlüssel hat die Verschlüsselung abgelehnt
ENDPOINT_NOT_ALLOWED, ENDPOINT_NOT_FOUND, ENDPOINT_UNREACHABLEDer Endpunkt wurde abgelehnt, ist unbekannt oder antwortet nicht
DELIVERY_NOT_CONFIGUREDAWS-Rollen-Ziele sind noch nicht verfügbar
STORAGE_ERROREin weiterer Speicherfehler

Beheben Sie die Ursache und führen Sie anschließend einen erneuten Test durch. Ein Ziel wird active wenn ein Test erfolgreich ist. Ein Ziel, das durch den SupportCHAMPREP deaktiviert wurde, kann von Ihnen nicht wieder aktiviert werden (DESTINATION_ADMIN_DISABLED).

Die Vorlage legt den Objektschlüssel jeder Datei fest. Der Standardwert lautet:

{project}/{yyyy}/{mm}/{dd}/{room}/{recording_id}/{file}
VariableWert
{project}Projekt-ID
{room}Raum-ID
{recording_id}Aufnahme-ID
{external_ref}Der Raum externalRef; none wenn es fehlt oder ungewöhnlich ist
{track_id}Titel-ID
{artifact}Welche Datei der Aufnahme
{file}<trackId>.mkv, recording.mp4, audio.m4a, oder für ein Transkript transcript.json und transcript.vtt
{yyyy}, {mm}, {dd}Datumsangaben

Die Aliase project_id, projectId, room_id, roomId, recordingId, externalRef und trackId werden ebenfalls akzeptiert.

Eine Vorlage muss enthalten {recording_id} und endet mit {file}. Literaler Text darf Buchstaben, Ziffern und ! _ . * ' ( ) / -. Es darf nicht mit / oder enthalten //, . oder .. Ordner. Ein Schlüssel darf höchstens 900 Byte groß sein.

  • Wenn eine Aufnahme ready, RTC kopiert jede seiner Dateien (jeden Track sowie die Composite-Dateien, sofern vorhanden) an jedes aktive Ziel seines Projekts. Ein fertiges Transkript wird auf dieselbe Weise übermittelt wie transcript.json und transcript.vtt.
  • Nur Aufnahmen, die nach der Aktivierung eines Ziels enden, werden automatisch übermittelt. Frühere Aufnahmen übermitteln Sie mit „redeliver“.
  • Dateien, die größer als 16 MiB sind, werden in Teilen versendet. RTC meldet den SHA-256-Hash der Bytes, die es versendet hat.
  • Ein fehlgeschlagener Versuch wird mit einer Wartezeit (1, 2, 4 … Minuten, maximal eine Stunde Abstand) 72 Stunden lang wiederholt. Danach schlägt die Übermittlung fehl und recording.delivery_failed wird versendet.
  • Die übertragenen Bytes werden auf das Download-Kontingent Ihres Tarifs angerechnet.
  • Das Deaktivieren eines Ziels bricht dessen in der Warteschlange befindliche Zustellungen ab. Das Entfernen des Ziels bewirkt dasselbe und löscht dessen Anmeldedaten.

Ein Worker, der während eines Uploads angehalten wird, kann unvollständige Teile in Ihrem Bucket hinterlassen. Fügen Sie ein AbortIncompleteMultipartUpload Lebenszyklusregel (1 Tag) für den Speicherbereich.

Abonnieren Sie Ihren Webhook-Endpunkte zu diesen Ereignissen. Jede Datei übermittlung sendet ein eigenes Ereignis.

Ereignisdata
recording.deliveredrecordingId, roomId, destinationId, artifact, trackId (für einen Titel), bucket, key, size, sha256, checksum, etag, deliveredAt
recording.delivery_failedrecordingId, roomId, destinationId, artifact, trackId (für einen Titel), bucket, key, attempts, error (code, message)

Eine Aufzeichnung enthält eine Zustellungsübersicht: delivery.state (pending, delivered, partial oder failed) und die pending, delivered und failed zählt.

GET /v1/recordings/{recordingId}/deliveries Zurück recordingId, dass summary und deliveries: Jeder Auftrag mit seinem Ziel-Bucket und Schlüssel, seinem Ergebnis (Größe, SHA-256 und ETag) sowie seinem letzten Fehler.

POST /v1/recordings/{recordingId}/redeliver mit einer optionalen { "destinationId": "…" } Startet fehlgeschlagene, abgebrochene und zugestellte Aufträge erneut mit einem neuen 72-Stunden-Zeitfenster und erstellt eventuell fehlende Aufträge.

HTTPCodeBedeutung
409RECORDING_NOT_READYNur eine ready Die Aufzeichnung kann zugestellt werden
409NO_ACTIVE_DESTINATIONFür diese Aufzeichnung gilt kein aktives Ziel
404NO_ACTIVE_DESTINATIONKein aktives Ziel verfügt über dies destinationId

Durch das Löschen einer Aufzeichnung wird diese in den Papierkorb verschoben. Sie wird nach 30 Tagen automatisch gelöscht, und Sie können sie bis dahin wiederherstellen. Jeder der folgenden Aufrufe erfordert einen Schlüssel mit recordings:write oder Ihre Konsolensitzung.

DELETE /v1/recordings/{recordingId} schickt die Aufzeichnung in den Papierkorb:

{ "id": "…", "status": "trashed", "trashedAt": "2026-11-08T12:00:00.000Z", "reason": "customer", "purgeAt": "2026-12-08T12:00:00.000Z" }
  • Die Aufzeichnung wird aus der Liste entfernt und GET /v1/recordings/{recordingId}. GET /v1/recordings?trashed=true listet die Aufzeichnungen im Papierkorb auf.
  • Die Downloads funktionieren nicht mehr, einschließlich bereits ausgegebener Download-Links.
  • Die in der Warteschlange befindlichen Zustellungen werden storniert.
  • Sie wird weiterhin auf den Speicherplatz für Aufzeichnungen angerechnet und in Rechnung gestellt, solange sie sich im Papierkorb befindet.
  • purgeAt Die automatische Löschung erfolgt 30 Tage nach dem Verschieben in den Papierkorb. Der Zeitpunkt ist fest, sobald die Aufzeichnung in den Papierkorb verschoben wurde: Eine spätere Änderung im Papierkorb-Fenster gilt nur für Aufzeichnungen, die danach in den Papierkorb verschoben wurden. purgeAt ist null während die automatische Löschung im Papierkorb deaktiviert ist.
  • recording.deleted wird gesendet.
  • Eine Aufzeichnung, die noch läuft oder noch verarbeitet wird, antwortet 409 RECORDING_ACTIVE; stoppen Sie den Vorgang oder warten Sie ab.

POST /v1/recordings/{recordingId}/restore holt die Aufzeichnung aus dem Papierkorb. Die Antwort ist die Aufzeichnung, die wieder in Ihren Listen und Downloads erscheint, so wie vor dem Löschen. recording.restored wird gesendet. Sie können eine Aufzeichnung wiederherstellen, bis sie automatisch gelöscht oder endgültig gelöscht wird. Eine Wiederherstellung, die zu spät erfolgt, antwortet 409 RECORDING_PURGED.

Übermittlungen an Ihren eigenen Speicher, die abgebrochen wurden, als die Aufzeichnung in den Papierkorb verschoben wurde, werden erneut gesendet. Eine wiederhergestellte Aufzeichnung wird so lange aufbewahrt, bis Sie sie erneut löschen: Die Aufbewahrungsfunktion verschiebt sie nicht zurück in den Papierkorb.

POST /v1/recordings/{recordingId}/purge löscht eine Aufzeichnung endgültig aus dem Papierkorb. RTC akzeptiert dies sofort und antwortet 202; der Löschvorgang ist in Kürze abgeschlossen:

{ "id": "…", "status": "deleting", "purgeRequestedAt": "2026-11-08T12:05:00.000Z" }
  • Er kann ab dem Zeitpunkt, an dem RTC die Anfrage annimmt, niemals wiederhergestellt werden.
  • Wenn die Löschung abgeschlossen ist, werden die zugehörigen Dateien gelöscht, sie wird nicht mehr auf den Speicherplatz für Aufzeichnungen angerechnet, und recording.purged wird gesendet.
  • Eine Wiederholung der Anfrage ist unbedenklich: Es wird geantwortet 202 erneut, während der Löschvorgang läuft, dann 200 Sobald dies geschehen ist: { "id": "…", "status": "purged", "purgedAt": "2026-11-08T12:05:30.000Z" }.
  • Nur eine Aufzeichnung im Papierkorb kann dauerhaft gelöscht werden. Jede andere Aufzeichnung antwortet 409 RECORDING_NOT_IN_TRASH: Senden Sie sie zunächst in den Papierkorb.

Eine Aufzeichnung wird dauerhaft gelöscht, sobald sie purgeAt (30 Tage im Papierkorb), auf dieselbe Weise, und recording.purged wird gesendet mit reason: "expired". Der CHAMPREP Support kann auf Ihren Wunsch hin auch eine Aufzeichnung im Papierkorb vorzeitig löschen.

Bereits an Ihren Bucket gelieferte Kopien gehören Ihnen. Das Verschieben einer Aufzeichnung in den Papierkorb, das dauerhafte Löschen oder die automatische Löschung führen niemals zu deren Entfernung.

CHAMPREP behält eine eigene Kopie einer Aufzeichnung für die Aufbewahrungsfrist Ihres Tarifs: 7 Tage in der Testversion, 30 Tage im Starter-Tarif, 90 Tage im Growth-Tarif und 365 Tage im Business-Tarif. Nach Ablauf dieser Frist wird die Aufzeichnung wie oben beschrieben in den Papierkorb verschoben, mit reason: "retention": Sie können ihn 30 Tage lang wiederherstellen; danach wird er automatisch gelöscht.

Die Aufbewahrungsfrist gilt nur für Aufzeichnungen, die nach Einführung der Aufbewahrungsfrist durch RTC erstellt wurden. Aufzeichnungen, die zuvor erstellt wurden, verfallen dadurch nicht. Die Aufbewahrungsfrist hat keinerlei Auswirkungen auf die Kopien in Ihrem eigenen Bucket.

keepCopyDays Bei einem Empfänger (0 bis 3650, Standard 7) wird festgehalten, wie lange Sie dessen Kopie nach einer Zustellung CHAMPREPaufbewahren möchten. CHAMPREPDie heutige Kopie folgt der Aufbewahrungsdauer Ihres Plans; diese Einstellung führt nicht zu einer vorzeitigen Löschung.