Je bekijkt de API-documentatie voor BigBlueButton 3.x. De huidige versie is BigBlueButton 4.x. Plan je een upgrade? De migratiehandleiding vermeldt alle wijzigingen die je in je API-aanroepen moet aanbrengen.
deleteRecordings – Opnames verwijderen
Het endpoint deleteRecordings verwijdert een of meer opnamen van je BigBlueButton-server. Je kunt één opname-ID of een door komma's gescheiden lijst meegeven om meerdere opnamen met éé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=deletedofstate=anydoor als de parameterstatein eengetRecordings-aanroep.
state=deleted.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
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.recordID. Alle opgegeven opnames worden in één aanroep verwijderd.SUCCESS en past de wijziging toe op alle geldige opnames. De server retourneert alleen FAILED met notFound als geen van de ID's overeenkomt met een bestaande opname.state in je deleted-aanroep op any of getRecordings te zetten. Standaard worden verwijderde opnames verborgen in de resultaten.