Aller au contenu
Documentation

RTC : apportez votre propre stockage

RTC peut copier chaque enregistrement terminé dans un compartiment dont vous êtes propriétaire. CHAMPREP Il conserve également sa propre copie, de sorte que l’enregistrement reste téléchargeable depuis RTC, que la diffusion aboutisse ou non.

La livraison vers votre propre espace de stockage est incluse dans le Croissance et Entreprise niveaux. L’essai gratuit, le niveau Starter et le quota inclus dans les formules payantes CHAMPREP ne l’incluent pas. Sans cela, les routes de stockage répondent 403 RTC_FEATURE_NOT_IN_PLAN avec les niveaux qui l’incluent dans offers. Voir plans et facturation.

Si votre forfait cesse de l’inclure, RTC désactive vos destinations. Après avoir effectué une nouvelle mise à niveau, réactivez-les une à une ; RTC effectue d’abord un nouveau test d’écriture.

TypeUtilisez-le pourCe que RTC conserve
aws-role (de préférence)Un compartiment AWS S3Rien de confidentiel. RTC suppose que vous créez un rôle IAM, doté d’un identifiant externe.
s3-compatibleCloudflare R2, MinIO, Wasabi, Backblaze B2 ou AWS avec des clés d’accèsVotre ID de clé d’accès et votre clé secrète, chiffrés

Une destination appartient à votre organisation. Elle dessert un projet, ou tous les projets lorsque projectId est null. Une organisation peut avoir jusqu’à 5 destinations ; une réponse supplémentaire 409 DESTINATION_LIMIT.

Créez, modifiez, testez et supprimez des destinations dans la console RTC, ou via l’API avecAPI votre session de console connectée. API Les clés ne peuvent ni créer ni modifier de destinations. Une clé disposant de recordings:read peut les répertorier ; une clé de projet voit les destinations de son projet et celles de tous les projets.

Méthode et chemin d’accèsIdentifiantRésultat
GET /v1/storage/destinationsSession de la console, ou une clé avec recordings:readLes destinations, classées par ordre chronologique décroissant
GET /v1/storage/destinations/{destinationId}Session de la console, ou une clé avec recordings:readUne destination
GET /v1/storage/aws-setupSession de la consoleVotre identifiant externe et les politiques IAM à coller (Rôle AWS)
POST /v1/storage/destinationsSession de la console201, la destination après son test d’écriture
PATCH /v1/storage/destinations/{destinationId}Session de la consoleModifiez les paramètres, effectuez la rotation des clés ou activez/désactivez le rôle
POST /v1/storage/destinations/{destinationId}/testSession de la consoleRelancez l’écriture de test
DELETE /v1/storage/destinations/{destinationId}Session de la console{ "id": "…", "deleted": true }
GET /v1/recordings/{recordingId}/deliveriesrecordings:readLes livraisons de l’enregistrement (Suivez les livraisons)
POST /v1/recordings/{recordingId}/redeliverrecordings:write202, renvoie l’enregistrement
DELETE /v1/recordings/{recordingId}recordings:writeEnvoie l’enregistrement dans la corbeille (Supprimer un enregistrement)
GET /v1/recordings?trashed=truerecordings:readLes enregistrements dans la corbeille
POST /v1/recordings/{recordingId}/restorerecordings:writeRécupère l’enregistrement de la corbeille
POST /v1/recordings/{recordingId}/purgerecordings:writeSupprime définitivement l’enregistrement de la corbeille

Les identifiants ne sont jamais renvoyés. Les réponses sont envoyées avec Cache-Control: no-store.

ChampLes deux typesNotes
type✓aws-role ou s3-compatible
name✓Votre libellé, jusqu’à 80 caractères
projectId✓Un projet, ou null pour chaque projet
bucket, region✓Le nom du compartiment et sa région
pathTemplate✓Facultatif ; voir Modèles de chemin d’accès
keepCopyDays✓Facultatif, de 0 à 3 650, valeur par défaut 7 ; voir rétention
roleArn, kmsKeyIdaws-roleVotre rôle, et éventuellement votre clé KMS pour SSE-KMS
provider, endpoint, forcePathStyle, accessKeyId, secretAccessKeys3-compatibleforcePathStyle La valeur par défaut est true

Une destination signale également son status (active, unverified ou disabled), lastCheck (la dernière écriture de test) et lastDelivery.

RTC ne conserve jamais vos clés AWS. Vous créez un rôle dans votre compte que le rôle de livraison de RTC peut endosser, limité par un identifiant externe unique à votre organisation.

  1. Appelez GET /v1/storage/aws-setup?bucket=<your-bucket> (ajoutez pathTemplate et kmsKeyArn (si vous les utilisez), ou ouvrez la même configuration dans la console.
  2. Créez un rôle IAM. Collez le code renvoyé trustPolicy: il ne fait confiance qu’à principalArn uniquement lorsque la requête comporte votre externalId.
  3. Associez le qui vous a été fourni permissionsPolicy. Il autorise s3:PutObject et s3:AbortMultipartUpload sous votre chemin d’accès, s3:DeleteObject uniquement sur le dossier de validation, et kms:GenerateDataKey et kms:Encrypt sur votre clé KMS alors que vous en aviez fourni une.
  4. Créez la destination avec type: "aws-role" et le rôle roleArn:
{
"type": "aws-role",
"name": "Recordings archive",
"projectId": null,
"bucket": "acme-rtc-recordings",
"region": "us-east-1",
"roleArn": "<your-delivery-role-arn>"
}

L’identifiant externe est créé une seule fois pour votre organisation et ne change pas. Lorsque available est false Dans la réponse de configuration, les destinations de rôle AWS ne sont pas encore disponibles et la création d’une destination donne la réponse suivante 503 DELIVERY_NOT_CONFIGURED; utilisez les clés d’accès en attendant.

Utilisation type: "s3-compatible" pour Cloudflare R2, MinIO, Wasabi, Backblaze B2 ou AWS lorsque vous préférez utiliser des clés d’accès. Indiquez le nom de votre service dans le provider champ, avec l’une des valeurs suivantes : r2, minio, wasabi, backblaze, aws ou other.

  • endpoint doit s’agir d’une origine HTTPS sur le port 443, sans chemin d’accès, requête ni nom d’utilisateur, en dehors des domainesCHAMPREP, et doit résoudre vers des adresses publiques. RTC vérifie à nouveau l’adresse à chaque connexion. Sinon, RTC répond 400 ENDPOINT_NOT_ALLOWED.
  • Accordez aux clés un accès en écriture au compartiment. Supprimez l’accès au champrep-rtc-validation/ Le dossier permet à RTC de supprimer son objet de test.
  • Les clés sont chiffrées au repos et ne sont jamais restituées. Une destination n’affiche que accessKeyIdHint, les quatre derniers caractères de l’ID de clé.
  • Pour effectuer la rotation des clés, PATCH accessKeyId et secretAccessKey à la fois.
  • Lorsque le stockage des clés n’est pas disponible, RTC répond 503 CREDENTIALS_UNAVAILABLE; utilisez un rôle AWS en attendant.

RTC teste une destination lorsque vous la créez, lorsque vous modifiez sa région, son modèle de chemin d’accès, son rôle, sa clé KMS, son point de terminaison, son style de chemin d’accès ou ses clés, lorsque vous la réactivez, et lorsque vous appelez POST /v1/storage/destinations/{destinationId}/test.

Le test écrit un objet de 64 octets vers <path prefix>/champrep-rtc-validation/<uuid>.txt puis le supprime. Une suppression refusée n’est qu’un avertissement : autorisez s3:DeleteObject sur ce dossier, ou supprimez l’objet vous-même.

Lorsque le test échoue, la destination est enregistrée sous la forme unverified et ne reçoit rien. lastCheck contient un code et une phrase :

CodeSignification
ROLE_ASSUME_DENIEDRTC n’a pas pu assumer le rôle (politique de confiance ou identifiant externe)
WRITE_DENIEDL’écriture a été refusée
BUCKET_NOT_FOUNDLe compartiment n’existe pas
WRONG_REGIONLe compartiment se trouve dans une autre région
INVALID_ACCESS_KEY, INVALID_SECRET_KEYLes clés ont été refusées
KMS_DENIEDLa clé KMS a refusé le chiffrement
ENDPOINT_NOT_ALLOWED, ENDPOINT_NOT_FOUND, ENDPOINT_UNREACHABLELe point de terminaison est refusé, inconnu ou ne répond pas
DELIVERY_NOT_CONFIGUREDLes destinations de rôle AWS ne sont pas encore disponibles
STORAGE_ERRORUne autre erreur de stockage

Corrigez la cause du problème, puis effectuez un nouveau test. Une destination devient active lorsqu’un test réussit. Une destination désactivée par le supportCHAMPREP ne peut pas être réactivée par vous (DESTINATION_ADMIN_DISABLED).

Le modèle définit la clé d’objet de chaque fichier. La valeur par défaut est :

{project}/{yyyy}/{mm}/{dd}/{room}/{recording_id}/{file}
VariableValeur
{project}Identifiant du projet
{room}Identifiant de la salle
{recording_id}Identifiant de l’enregistrement
{external_ref}La salle externalRef; none lorsqu’il est absent ou inhabituel
{track_id}Identifiant de piste
{artifact}Quel fichier de l’enregistrement
{file}<trackId>.mkv, recording.mp4, audio.m4a, ou pour un transcription transcript.json et transcript.vtt
{yyyy}, {mm}, {dd}Éléments de date

Les alias project_id, projectId, room_id, roomId, recordingId, externalRef et trackId sont également acceptés.

Un modèle doit contenir {recording_id} et se termine par {file}. Le texte littéral peut comporter des lettres, des chiffres et ! _ . * ' ( ) / -. Elle ne peut pas commencer par / ou contenir //, . ou .. dossiers. Une clé ne peut pas dépasser 900 octets.

  • Lorsqu’un enregistrement est ready, RTC copie chacun de ses fichiers (chaque piste, ainsi que les fichiers composites le cas échéant) vers chaque destination active de son projet. Une transcription terminée transcription est transmise de la même manière que transcript.json et transcript.vtt.
  • Seuls les enregistrements qui s’achèvent après l’activation d’une destination sont transmis automatiquement. Pour transmettre les enregistrements antérieurs, utilisez redeliver.
  • Les fichiers de plus de 16 Mio sont envoyés par parties. RTC communique la valeur SHA-256 des octets qu’il a envoyés.
  • En cas d’échec, une nouvelle tentative est effectuée avec un délai d’attente (1, 2, 4… minutes, avec un intervalle maximal d’une heure) pendant 72 heures. Passé ce délai, la transmission est considérée comme ayant échoué et recording.delivery_failed est envoyée.
  • Les octets transférés sont pris en compte dans le quota de téléchargement de votre forfait.
  • La désactivation d’une destination annule ses envois en file d’attente. Sa suppression a le même effet et supprime ses identifiants.

Un processus interrompu au milieu d’un téléchargement peut laisser des parties incomplètes dans votre compartiment. Ajoutez un AbortIncompleteMultipartUpload règle de cycle de vie (1 jour) vers le compartiment.

Abonnez-vous à votre Points de terminaison des webhooks à ces événements. Chaque transfert de fichier génère son propre événement.

Événementdata
recording.deliveredrecordingId, roomId, destinationId, artifact, trackId (pour une piste), bucket, key, size, sha256, checksum, etag, deliveredAt
recording.delivery_failedrecordingId, roomId, destinationId, artifact, trackId (pour une piste), bucket, key, attempts, error (code, message)

Un enregistrement comporte un récapitulatif de livraison : delivery.state (pending, delivered, partial ou failed) et le pending, delivered et failed compte.

GET /v1/recordings/{recordingId}/deliveries revient recordingId, c’est-à-dire que summary et deliveries: chaque tâche avec son compartiment cible et sa clé, son résultat (taille, SHA-256 et ETag) et sa dernière erreur.

POST /v1/recordings/{recordingId}/redeliver avec une option facultative { "destinationId": "…" } relance les tâches ayant échoué, annulées ou livrées avec une nouvelle fenêtre de 72 heures et crée celles qui manquent.

HTTPCodeSignification
409RECORDING_NOT_READYSeul un ready L’enregistrement peut être livré
409NO_ACTIVE_DESTINATIONAucune destination active ne s’applique à cet enregistrement
404NO_ACTIVE_DESTINATIONAucune destination active ne présente cette caractéristique destinationId

La suppression d’un enregistrement l’envoie dans la corbeille. Il est supprimé automatiquement au bout de 30 jours, et vous pouvez le restaurer jusqu’à ce moment-là. Chaque appel ci-dessous nécessite une clé avec recordings:write ou votre session de console.

DELETE /v1/recordings/{recordingId} Envoie l’enregistrement dans la corbeille :

{ "id": "…", "status": "trashed", "trashedAt": "2026-11-08T12:00:00.000Z", "reason": "customer", "purgeAt": "2026-12-08T12:00:00.000Z" }
  • L’enregistrement quitte la liste et GET /v1/recordings/{recordingId}. GET /v1/recordings?trashed=true affiche la liste des enregistrements présents dans la corbeille.
  • Les téléchargements cessent de fonctionner, y compris les liens de téléchargement déjà générés.
  • Ses envois en file d’attente sont annulés.
  • Il continue de compter dans l’espace de stockage des enregistrements et est facturé tant qu’il se trouve dans la Corbeille.
  • purgeAt La suppression automatique intervient : 30 jours après son envoi dans la corbeille. Ce délai est fixé au moment où l’enregistrement est envoyé dans la corbeille : toute modification ultérieure de la fenêtre « Corbeille » ne s’applique qu’aux enregistrements envoyés dans la corbeille après cette opération. purgeAt C’est null tandis que la suppression automatique de la corbeille est désactivée.
  • recording.deleted est envoyé.
  • Un enregistrement encore en cours d’exécution ou de traitement répond 409 RECORDING_ACTIVE; arrêtez-le ou attendez.

POST /v1/recordings/{recordingId}/restore récupère l’enregistrement de la corbeille. La réponse correspond à l’enregistrement, qui réapparaît dans vos listes et vos téléchargements comme avant sa suppression. recording.restored est envoyé. Vous pouvez restaurer un enregistrement jusqu’à ce qu’il soit supprimé automatiquement ou définitivement. Une restauration qui intervient trop tard répond 409 RECORDING_PURGED.

Les envois vers votre propre espace de stockage qui ont été annulés lorsque l’enregistrement a été déplacé vers la Corbeille sont renvoyés. Un enregistrement restauré est conservé jusqu’à ce que vous le supprimiez à nouveau : la conservation ne le renvoie pas dans la Corbeille.

POST /v1/recordings/{recordingId}/purge supprime définitivement un enregistrement de la corbeille. Le RTC l’accepte immédiatement et répond 202; la suppression s’achève rapidement :

{ "id": "…", "status": "deleting", "purgeRequestedAt": "2026-11-08T12:05:00.000Z" }
  • Il ne peut en aucun cas être rétabli, dès lors que RTC a accepté la requête.
  • Une fois la suppression effectuée, ses fichiers sont effacés, elle ne compte plus dans le stockage des enregistrements, et recording.purged est envoyé.
  • Il est sans risque de réitérer la requête : elle renvoie 202 à nouveau pendant que la suppression s’exécute, puis 200 une fois que c’est fait : { "id": "…", "status": "purged", "purgedAt": "2026-11-08T12:05:30.000Z" }.
  • Seul un enregistrement situé dans la corbeille peut être supprimé définitivement. Tout autre enregistrement répond 409 RECORDING_NOT_IN_TRASH: envoyez-le d’abord dans la corbeille.

Un enregistrement est supprimé définitivement à son purgeAt (30 jours dans la corbeille), de la même manière, et recording.purged est envoyé avec reason: "expired". Le service CHAMPREP d’assistance peut également supprimer plus tôt un enregistrement se trouvant dans la corbeille, à votre demande.

Les copies déjà livrées dans votre compartiment vous appartiennent. Envoyer un enregistrement dans la Corbeille, le supprimer définitivement ou activer sa suppression automatique ne les supprime jamais.

CHAMPREP conserve sa propre copie d’un enregistrement pendant la durée de conservation prévue par votre forfait : 7 jours pour la version d’essai, 30 jours pour le forfait Starter, 90 jours pour le forfait Growth et 365 jours pour le forfait Business. Une fois ce délai écoulé, l’enregistrement est envoyé dans la corbeille de la même manière que ci-dessus, avec reason: "retention": vous pouvez le restaurer pendant 30 jours, après quoi il est supprimé automatiquement.

La conservation ne s’applique qu’aux enregistrements effectués après que RTC a commencé à l’appliquer. Les enregistrements effectués avant cette date ne sont pas supprimés par ce mécanisme. La conservation n’affecte jamais les copies présentes dans votre propre compartiment.

keepCopyDays Sur une destination (0 à 3650, par défaut 7), ce paramètre enregistre la durée pendant laquelle vous souhaitez CHAMPREPconserver sa copie après une livraison. La copie CHAMPREPdu jour suit la durée de conservation de votre forfait ; ce paramètre ne la supprime pas plus tôt.