Capitolo 13 GET POST

deleteRecordings – Elimina registrazioni

L'endpoint deleteRecordings elimina definitivamente una o più registrazioni dal tuo server BigBlueButton. Puoi passare un singolo ID di registrazione o un elenco separato da virgole per rimuovere più registrazioni in un'unica richiesta.

Questa chiamata API ha effetto immediato senza alcuna richiesta di conferma. Assicurati di avere gli ID registrazione corretti prima di inviare la richiesta. Le registrazioni eliminate non possono essere ripristinate tramite l'API.

Endpoint

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

Parametri

Parametro Tipo Obbligatorio Predefinito Descrizione
recordID String Sì — Un singolo ID di registrazione o un elenco di ID di registrazione separati da virgole da eliminare.

Esempio di richiesta

Eliminare una singola registrazione: 

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

Eliminare più registrazioni in una sola chiamata: 

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

Risposta di esempio

Una chiamata riuscita restituisce il seguente XML: 

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

Risposte di errore

messageKey Descrizione
checksumError Il checksum non è valido.
missingParamRecordID Il parametro recordID non è stato fornito.
notFound Nessuna registrazione con l'ID specificato è stata trovata sul server.

Le registrazioni non vengono rimosse fisicamente dal disco immediatamente. Il server sposta i file in una directory deleted/. Un amministratore del server può potenzialmente recuperare le registrazioni eliminate da questa directory prima che vengano eliminate definitivamente.

Comportamento dopo l'eliminazione

  • Lo stato della registrazione cambia in deleted.
  • Le registrazioni eliminate non compaiono più nelle risposte standard di getRecordings.
  • Per recuperare le registrazioni eliminate tramite l'API, passa state=deleted o state=any come parametro state in una chiamata a getRecordings.
Su bbbserver.de, puoi chiamare questo endpoint usando le credenziali API che trovi nella dashboard di gestione del server. Assicurati che gli ID delle registrazioni corrispondano a registrazioni appartenenti alla tua istanza del server.

Best practice

Verifica sempre gli ID delle registrazioni con una chiamata a getRecordings prima di eliminarle, per evitare di rimuovere le registrazioni sbagliate.

Implementa un passaggio di conferma nella tua applicazione prima di chiamare questo endpoint, poiché l'API stessa non richiede conferma.

Registra ogni richiesta di eliminazione, inclusi gli ID delle registrazioni e i timestamp, in modo da poter tracciare quali registrazioni sono state rimosse e quando.

Quando elimini più registrazioni, raggruppale in un'unica richiesta separata da virgole invece di effettuare chiamate API individuali per ciascuna registrazione.

Domande frequenti

Non immediatamente. Il server sposta i file della registrazione in una directory deleted dedicata. Un amministratore del server può recuperarli da lì finché i file non vengono eliminati definitivamente da un processo di pulizia. Tuttavia, non esiste un endpoint API per ripristinare le registrazioni eliminate.

Sì. Passa un elenco di ID registrazione separati da virgole nel parametro recordID. Tutte le registrazioni specificate verranno eliminate in un'unica chiamata.

L'API può restituire un errore notFound se nessuno degli ID registrazione specificati può essere associato. Quando si mescolano ID validi e non validi, il comportamento può variare in base alla versione BigBlueButton. Si consiglia di verificare tutti gli ID prima di inviare la richiesta.

Sì, ma solo se le richiedi esplicitamente impostando il parametro state su deleted o any nella tua chiamata getRecordings. Per impostazione predefinita, le registrazioni eliminate sono nascoste nei risultati.

No. L'API BigBlueButton non fornisce un endpoint per ripristinare le registrazioni eliminate. Il recupero è possibile solo a livello di filesystem del server da parte di un amministratore di sistema.