Kapitel 13 GET POST

deleteRecordings – Slet optagelser

deleteRecordings-endpointet sletter permanent en eller flere optagelser fra din BigBlueButton-server. Du kan angive ét enkelt optagelses-ID eller en kommasepareret liste for at fjerne flere optagelser i én anmodning.

Dette API-kald træder i kraft med det samme uden nogen bekræftelsesdialog. Sørg for, at du har de korrekte optagelses-ID'er, før du sender anmodningen. Slettede optagelser kan ikke gendannes via API'et.

Endepunkt

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

Parametre

Parameter Type Påkrævet Standard Beskrivelse
recordID String Ja — Et enkelt optagelses-ID eller en kommasepareret liste over optagelses-ID'er, der skal slettes.

Eksempel på anmodning

Slet en enkelt optagelse: 

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

Slet flere optagelser i ét kald: 

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

Eksempelsvar

Et vellykket kald returnerer følgende XML: 

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

Fejlsvar

messageKey Beskrivelse
checksumError checksum er ugyldig.
missingParamRecordID Parameteren recordID blev ikke angivet.
notFound Der blev ikke fundet nogen optagelse med det angivne ID på serveren.

Optagelser fjernes ikke fysisk fra disken med det samme. Serveren flytter filerne til et deleted/-bibliotek. En serveradministrator kan muligvis gendanne slettede optagelser fra dette bibliotek, før de bliver permanent fjernet.

Adfærd efter sletning

  • Optagelsens status ændres til deleted.
  • Slettede optagelser vises ikke længere i standard-svar fra getRecordings.
  • For at hente slettede optagelser via API'et skal du angive state=deleted eller state=any som parameteren state i et getRecordings-kald.
På bbbserver.de kan du kalde dette endpoint med dine API-legitimationsoplysninger, som findes i serveradministrationsdashboardet. Sørg for, at optagelses-ID'erne matcher optagelser, der tilhører din serverinstans.

Bedste praksis

Kontrollér altid optagelses-ID'er med et getRecordings-kald før sletning for at undgå at fjerne de forkerte optagelser.

Implementér et bekræftelsestrin i din applikation, før du kalder dette endpoint, da API'et selv ikke kræver bekræftelse.

Log hver sletteanmodning, inklusive optagelses-ID'er og tidsstempler, så du kan spore, hvilke optagelser der blev fjernet, og hvornår.

Når du sletter flere optagelser, så saml dem i én kommasepareret anmodning i stedet for at foretage individuelle API-kald for hver optagelse.

Ofte stillede spørgsmål

Ikke med det samme. Serveren flytter optagelsesfilerne til en dedikeret deleted-mappe. En serveradministrator kan gendanne dem derfra, indtil filerne permanent fjernes af en oprydningsproces. Der findes dog ikke noget API-endpoint til at gendanne slettede optagelser.

Ja. Angiv en kommasepareret liste over optagelses-ID'er i parameteren recordID. Alle angivne optagelser bliver slettet i ét kald.

API'et kan returnere en notFound-fejl, hvis ingen af de angivne optagelses-ID'er kan matches. Ved blanding af gyldige og ugyldige ID'er kan adfærden variere afhængigt af BigBlueButton-versionen. Det anbefales at verificere alle ID'er, før anmodningen sendes.

Ja, men kun hvis du udtrykkeligt anmoder om dem ved at sætte parameteren state til deleted eller any i dit getRecordings-kald. Som standard er slettede optagelser skjult i resultaterne.

Nej. BigBlueButton-API'et tilbyder ikke et endpoint til at gendanne slettede optagelser. Gendannelse er kun mulig på serverens filsystemniveau af en systemadministrator.