Kapitel 13 GET POST

deleteRecordings – Aufzeichnungen löschen

Der Endpunkt deleteRecordings löscht dauerhaft eine oder mehrere Aufzeichnungen von Ihrem BigBlueButton-Server. Sie können eine einzelne Aufzeichnungs-ID oder eine kommagetrennte Liste übergeben, um mehrere Aufzeichnungen in einer Anfrage zu entfernen.

Dieser API-Aufruf wird sofort und ohne Bestätigungsabfrage wirksam. Stellen Sie sicher, dass Sie die richtigen Aufzeichnungs-IDs haben, bevor Sie die Anfrage senden. Gelöschte Aufzeichnungen können über die API nicht wiederhergestellt werden.

Endpunkt

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

Parameter

Parameter Typ Erforderlich Standard Beschreibung
recordID String Ja — Eine einzelne Aufnahme-ID oder eine durch Kommas getrennte Liste von Aufnahme-IDs zum Löschen.

Beispielanfrage

Eine einzelne Aufnahme löschen: 

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

Mehrere Aufnahmen in einem Aufruf löschen: 

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

Beispielantwort

Ein erfolgreicher Aufruf gibt das folgende XML zurück: 

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

Fehlerantworten

messageKey Beschreibung
checksumError Das checksum ist ungültig.
missingParamRecordID Der Parameter recordID wurde nicht angegeben.
notFound Auf dem Server wurde keine Aufnahme mit der angegebenen ID gefunden.

Aufnahmen werden nicht sofort physisch von der Festplatte entfernt. Der Server verschiebt die Dateien in ein deleted/-Verzeichnis. Ein Serveradministrator kann gelöschte Aufnahmen möglicherweise aus diesem Verzeichnis wiederherstellen, bevor sie endgültig gelöscht werden.

Verhalten nach dem Löschen

  • Der Status der Aufnahme ändert sich zu deleted.
  • Gelöschte Aufnahmen erscheinen nicht mehr in den standardmäßigen getRecordings-Antworten.
  • Um gelöschte Aufnahmen über die API abzurufen, übergeben Sie state=deleted oder state=any als state-Parameter in einem getRecordings-Aufruf.
Auf bbbserver.de können Sie diesen Endpunkt mit Ihren API-Zugangsdaten aufrufen, die Sie im Serververwaltungs-Dashboard finden. Stellen Sie sicher, dass die Aufnahme-IDs zu Aufnahmen gehören, die zu Ihrer Serverinstanz gehören.

Bewährte Methoden

Überprüfen Sie Aufnahme-IDs immer mit einem getRecordings-Aufruf, bevor Sie sie löschen, um zu vermeiden, dass die falschen Aufnahmen entfernt werden.

Implementieren Sie in Ihrer Anwendung einen Bestätigungsschritt, bevor Sie diesen Endpunkt aufrufen, da die API selbst keine Bestätigung erfordert.

Protokollieren Sie jede Löschanfrage, einschließlich der Aufnahme-IDs und Zeitstempel, damit Sie nachvollziehen können, welche Aufnahmen wann entfernt wurden.

Wenn Sie mehrere Aufnahmen löschen, fassen Sie sie in einer einzigen kommagetrennten Anfrage zusammen, anstatt für jede Aufnahme einzelne API-Aufrufe zu machen.

Häufig gestellte Fragen

Nicht sofort. Der Server verschiebt die Aufzeichnungsdateien in ein spezielles deleted-Verzeichnis. Ein Serveradministrator kann sie von dort wiederherstellen, bis die Dateien durch einen Bereinigungsprozess dauerhaft gelöscht werden. Es gibt jedoch keinen API-Endpunkt, um gelöschte Aufzeichnungen wiederherzustellen.

Ja. Übergeben Sie eine kommagetrennte Liste von Aufzeichnungs-IDs im Parameter recordID. Alle angegebenen Aufzeichnungen werden in einem Aufruf gelöscht.

Die API kann einen notFound-Fehler zurückgeben, wenn keine der angegebenen Aufzeichnungs-IDs zugeordnet werden kann. Beim Mischen gültiger und ungültiger IDs kann das Verhalten je nach BigBlueButton-Version variieren. Es wird empfohlen, alle IDs zu prüfen, bevor die Anfrage gesendet wird.

Ja, aber nur, wenn Sie sie ausdrücklich anfordern, indem Sie den Parameter state in Ihrem deleted-Aufruf auf any oder getRecordings setzen. Standardmäßig sind gelöschte Aufzeichnungen in den Ergebnissen ausgeblendet.

Nein. Die BigBlueButton-API stellt keinen Endpunkt zur Wiederherstellung gelöschter Aufzeichnungen bereit. Eine Wiederherstellung ist nur auf Ebene des Server-Dateisystems durch einen Systemadministrator möglich.