Hoofdstuk 13 GET POST

deleteRecordings – Opnames verwijderen

Met het deleteRecordings-endpoint kun je permanent een of meer opnames verwijderen van je BigBlueButton-server. Je kunt één opname-ID doorgeven of een door komma's gescheiden lijst om meerdere opnames in één verzoek te verwijderen.

Deze API-aanroep wordt onmiddellijk uitgevoerd zonder enige bevestigingsprompt. Zorg ervoor dat je de juiste opname-ID's hebt voordat je het verzoek verzendt. Verwijderde opnames kunnen niet via de API worden hersteld.

Endpoint

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

Parameters

Parameter Type Vereist Standaard Beschrijving
recordID String Ja — Een enkele opname-ID of een door komma's gescheiden lijst met opname-ID's om te verwijderen.

Voorbeeldverzoek

Een enkele opname verwijderen: 

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

Meerdere opnames in één aanroep verwijderen: 

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

Voorbeeldrespons

Een succesvolle aanroep retourneert de volgende XML: 

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

Foutresponses

messageKey Beschrijving
checksumError De checksum is ongeldig.
missingParamRecordID De parameter recordID is niet opgegeven.
notFound Er is geen opname met de opgegeven ID op de server gevonden.

Opnames worden niet onmiddellijk fysiek van de schijf verwijderd. De server verplaatst de bestanden naar een map deleted/. Een serverbeheerder kan verwijderde opnames mogelijk uit deze map herstellen voordat ze definitief worden opgeschoond.

Gedrag na verwijdering

  • De opnamestatus verandert in deleted.
  • Verwijderde opnames verschijnen niet langer in standaard getRecordings-antwoorden.
  • Om verwijderde opnames via de API op te halen, geef je state=deleted of state=any door als de parameter state in een getRecordings-aanroep.
Op bbbserver.de kun je dit endpoint aanroepen met je API-inloggegevens die je vindt in het serverbeheerdashboard. Zorg ervoor dat de opname-ID's overeenkomen met opnames die bij jouw serverinstantie horen.

Beste praktijken

Controleer opname-ID's altijd met een getRecordings-aanroep voordat je verwijdert, om te voorkomen dat de verkeerde opnames worden verwijderd.

Implementeer een bevestigingsstap in je applicatie voordat je dit endpoint aanroept, aangezien de API zelf geen bevestiging vereist.

Log elk verwijderverzoek, inclusief de opname-ID's en tijdstempels, zodat je kunt nagaan welke opnames zijn verwijderd en wanneer.

Wanneer je meerdere opnames verwijdert, bundel ze dan in één door komma's gescheiden verzoek in plaats van voor elke opname afzonderlijke API-aanroepen te doen.

Veelgestelde vragen

Niet onmiddellijk. De server verplaatst de opnamebestanden naar een speciale deleted-map. Een serverbeheerder kan ze daar herstellen totdat de bestanden permanent worden verwijderd door een opschoningsproces. Er is echter geen API-endpoint om verwijderde opnames te herstellen.

Ja. Geef een door komma's gescheiden lijst van opname-ID's door in de parameter recordID. Alle opgegeven opnames worden in één aanroep verwijderd.

De API kan een notFound-fout retourneren als geen van de opgegeven opname-ID's kan worden gevonden. Bij een mix van geldige en ongeldige ID's kan het gedrag verschillen per BigBlueButton-versie. Het wordt aanbevolen om alle ID's te verifiëren voordat je het verzoek verzendt.

Ja, maar alleen als je er expliciet om vraagt door de parameter state in je deleted-aanroep op any of getRecordings te zetten. Standaard worden verwijderde opnames verborgen in de resultaten.

Nee. De BigBlueButton-API biedt geen endpoint om verwijderde opnames te herstellen. Herstel is alleen mogelijk op het niveau van het serverbestandssysteem door een systeembeheerder.