Rozdział 13 GET POST

deleteRecordings – Usuń nagrania

Punkt końcowy deleteRecordings trwale usuwa jedno lub więcej nagrań z Twojego serwera BigBlueButton. Możesz przekazać pojedynczy identyfikator nagrania lub listę rozdzieloną przecinkami, aby usunąć wiele nagrań w jednym żądaniu.

To wywołanie API działa natychmiast, bez żadnego monitu o potwierdzenie. Upewnij się, że masz poprawne identyfikatory nagrań przed wysłaniem żądania. Usuniętych nagrań nie można przywrócić przez API.

Punkt końcowy

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

Parametry

Parametr Typ Wymagane Domyślnie Opis
recordID String Tak — Pojedynczy identyfikator nagrania lub rozdzielona przecinkami lista identyfikatorów nagrań do usunięcia.

Przykładowe żądanie

Usuń pojedyncze nagranie: 

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

Usuń wiele nagrań w jednym wywołaniu: 

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

Przykładowa odpowiedź

Pomyślne wywołanie zwraca następujący XML: 

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

Odpowiedzi błędów

messageKey Opis
checksumError checksum jest nieprawidłowy.
missingParamRecordID Nie podano parametru recordID.
notFound Na serwerze nie znaleziono nagrania o podanym identyfikatorze.

Nagrania nie są natychmiast fizycznie usuwane z dysku. Serwer przenosi pliki do katalogu deleted/. Administrator serwera może potencjalnie odzyskać usunięte nagrania z tego katalogu, zanim zostaną trwale usunięte.

Zachowanie po usunięciu

  • Status nagrania zmienia się na deleted.
  • Usunięte nagrania nie pojawiają się już w standardowych odpowiedziach getRecordings.
  • Aby pobrać usunięte nagrania przez API, przekaż state=deleted lub state=any jako parametr state w wywołaniu getRecordings.
W bbbserver.de możesz wywołać ten endpoint, używając swoich danych uwierzytelniających API znalezionych w panelu zarządzania serwerem. Upewnij się, że identyfikatory nagrań odpowiadają nagraniom należącym do instancji twojego serwera.

Najlepsze praktyki

Zawsze weryfikuj identyfikatory nagrań za pomocą wywołania getRecordings przed usunięciem, aby uniknąć usunięcia niewłaściwych nagrań.

Zaimplementuj w swojej aplikacji krok potwierdzenia przed wywołaniem tego endpointu, ponieważ samo API nie wymaga potwierdzenia.

Rejestruj każde żądanie usunięcia, w tym identyfikatory nagrań i znaczniki czasu, aby móc prześledzić, które nagrania zostały usunięte i kiedy.

Podczas usuwania wielu nagrań grupuj je w jedno żądanie rozdzielone przecinkami, zamiast wykonywać osobne wywołania API dla każdego nagrania.

Najczęściej zadawane pytania

Nie od razu. Serwer przenosi pliki nagrania do dedykowanego katalogu deleted. Administrator serwera może je stamtąd odzyskać, dopóki pliki nie zostaną trwale usunięte przez proces czyszczenia. Nie istnieje jednak punkt końcowy API do przywracania usuniętych nagrań.

Tak. Przekaż listę identyfikatorów nagrań rozdzieloną przecinkami w parametrze recordID. Wszystkie wskazane nagrania zostaną usunięte w jednym wywołaniu.

API może zwrócić błąd notFound, jeśli żadnego z podanych identyfikatorów nagrań nie da się dopasować. Przy mieszaniu prawidłowych i nieprawidłowych identyfikatorów zachowanie może się różnić w zależności od wersji BigBlueButton. Zaleca się zweryfikowanie wszystkich identyfikatorów przed wysłaniem żądania.

Tak, ale tylko jeśli wyraźnie o nie poprosisz, ustawiając parametr state na deleted lub any w wywołaniu getRecordings. Domyślnie usunięte nagrania są ukryte w wynikach.

Nie. API BigBlueButton nie udostępnia punktu końcowego do przywracania usuniętych nagrań. Odzyskanie jest możliwe wyłącznie na poziomie systemu plików serwera przez administratora systemu.