Chapitre 13 GET POST

deleteRecordings – Supprimer les enregistrements

Le point de terminaison deleteRecordings supprime définitivement un ou plusieurs enregistrements de votre serveur BigBlueButton. Vous pouvez transmettre un seul identifiant d’enregistrement ou une liste séparée par des virgules pour supprimer plusieurs enregistrements en une seule requête.

Cet appel API prend effet immédiatement sans demande de confirmation. Assurez-vous d’avoir les bons identifiants d’enregistrement avant d’envoyer la requête. Les enregistrements supprimés ne peuvent pas être restaurés via l’API.

Point de terminaison

GET https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?<parameters>&checksum=replace-with-checksum

Paramètres

Paramètre Type Obligatoire Par défaut Description
recordID String Oui — Un seul identifiant d’enregistrement ou une liste d’identifiants d’enregistrement séparés par des virgules à supprimer.

Exemple de requête

Supprimer un seul enregistrement : 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id&checksum=replace-with-checksum

Supprimer plusieurs enregistrements en un seul appel : 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id-1,replace-with-recording-id-2&checksum=replace-with-checksum

Exemple de réponse

Un appel réussi renvoie le XML suivant : 

<response>
  <returncode>SUCCESS</returncode>
  <deleted>true</deleted>
</response>

Réponses d’erreur

messageKey Description
checksumError Le checksum est invalide.
missingParamRecordID Le paramètre recordID n’a pas été fourni.
notFound Aucun enregistrement avec l’identifiant spécifié n’a été trouvé sur le serveur.

Les enregistrements ne sont pas physiquement supprimés du disque immédiatement. Le serveur déplace les fichiers dans un répertoire deleted/. Un administrateur du serveur peut potentiellement récupérer les enregistrements supprimés depuis ce répertoire avant qu’ils ne soient définitivement purgés.

Comportement après suppression

  • Le statut de l’enregistrement passe à deleted.
  • Les enregistrements supprimés n’apparaissent plus dans les réponses getRecordings standard.
  • Pour récupérer les enregistrements supprimés via l’API, transmettez state=deleted ou state=any comme paramètre state dans un appel getRecordings.
Sur bbbserver.de, vous pouvez appeler ce point de terminaison en utilisant vos identifiants API trouvés dans le tableau de bord de gestion du serveur. Assurez-vous que les identifiants d’enregistrement correspondent à des enregistrements appartenant à votre instance de serveur.

Bonnes pratiques

Vérifiez toujours les identifiants d’enregistrement avec un appel getRecordings avant de supprimer, afin d’éviter de supprimer les mauvais enregistrements.

Implémentez une étape de confirmation dans votre application avant d’appeler ce point de terminaison, puisque l’API elle-même n’exige pas de confirmation.

Journalisez chaque demande de suppression, y compris les identifiants d’enregistrement et les horodatages, afin de pouvoir retracer quels enregistrements ont été supprimés et à quel moment.

Lors de la suppression de plusieurs enregistrements, regroupez-les dans une seule requête séparée par des virgules plutôt que d’effectuer des appels API individuels pour chaque enregistrement.

Foire aux questions

Pas immédiatement. Le serveur déplace les fichiers d’enregistrement dans un répertoire deleted dédié. Un administrateur du serveur peut les récupérer à partir de là jusqu’à ce que les fichiers soient définitivement purgés par un processus de nettoyage. Cependant, aucun point de terminaison API ne permet de restaurer des enregistrements supprimés.

Oui. Transmettez une liste d’identifiants d’enregistrement séparés par des virgules dans le paramètre recordID. Tous les enregistrements spécifiés seront supprimés en un seul appel.

L’API peut renvoyer une erreur notFound si aucun des identifiants d’enregistrement spécifiés ne peut être associé. En cas de mélange d’identifiants valides et invalides, le comportement peut varier selon la version BigBlueButton. Il est recommandé de vérifier tous les identifiants avant d’envoyer la requête.

Oui, mais seulement si vous les demandez explicitement en définissant le paramètre state sur deleted ou any dans votre appel getRecordings. Par défaut, les enregistrements supprimés sont masqués dans les résultats.

Non. L’API BigBlueButton ne fournit pas de point de terminaison pour restaurer des enregistrements supprimés. La récupération n’est possible qu’au niveau du système de fichiers du serveur par un administrateur système.