Rozdział 14 GET POST

updateRecordings – Zaktualizuj metadane

Punkt końcowy updateRecordings umożliwia dodawanie, modyfikowanie lub usuwanie metadanych jednej lub większej liczby istniejących nagrań. Jest to przydatne do oznaczania nagrań po zakończeniu spotkania — na przykład przez dodanie nazwy prezentera, kategorii lub identyfikatora kursu — bez ponownego przetwarzania samego nagrania.

Punkt końcowy

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings?<parameter>&checksum=replace-with-checksum

Obsługiwane są zarówno metody GET, jak i POST. W przypadku użycia POST należy wysłać parametry jako application/x-www-form-urlencoded w treści żądania.

Wymagane parametry

Parametr Typ Opis
recordID String Wymagane. Lista identyfikatorów nagrań oddzielonych przecinkami, których metadane mają zostać zaktualizowane. Możesz zaktualizować wiele nagrań w jednym wywołaniu, oddzielając identyfikatory przecinkami.

Parametry opcjonalne

Parametr Typ Opis
meta_<key> String Jedna lub więcej par klucz-wartość metadanych. Niepusta wartość ustawia lub aktualizuje wpis metadanych. Pusta wartość całkowicie usuwa wpis metadanych. Nazwa klucza ma taki sam format jak w wywołaniu create.

Jak działają aktualizacje metadanych

Przekaż jeden lub więcej parametrów meta_<key> z niepustą wartością, aby ustawić lub zaktualizować odpowiedni wpis metadanych.

Przekaż parametr meta_<key> z pustą wartością, aby usunąć ten wpis metadanych.

Wszelkie istniejące wpisy metadanych, które nie zostaną uwzględnione w wywołaniu, pozostają bez zmian.

Przykładowe żądanie

Ustawianie metadanych

GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
    ?recordID=replace-with-recording-id
  &meta_Presenter=Max+Mustermann
  &meta_category=FINANCE
    &checksum=replace-with-checksum

Usuwanie metadanych

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

Żądanie POST z użyciem cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&meta_Presenter=Max+Mustermann&meta_category=FINANCE&checksum=replace-with-checksum"

Przykładowa odpowiedź

Sukces

<response>
  <returncode>SUCCESS</returncode>
  <updated>true</updated>
</response>

Błąd — brak recordID

<response>
  <returncode>FAILED</returncode>
  <messageKey>missingParamRecordID</messageKey>
  <message>You must specify a recordID.</message>
</response>

Błąd — nie znaleziono nagrania

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find a recording with that recordID.</message>
</response>

Odpowiedzi błędów

Klucz komunikatu Opis
checksumError Parametr checksum jest nieprawidłowy lub nie zgadza się z oczekiwaną wartością.
missingParamRecordID Nie podano wymaganego parametru recordID.
notFound Nie znaleziono nagrania o podanym ID. Serwer przeszukuje tylko nagrania published i unpublished — usuniętych nagrań nie można aktualizować.

Uwagi bbbserver.de

bbbserver.de: Punkt końcowy updateRecordings jest niedostępny na bbbserver.de. Metadane muszą zostać ustawione podczas wywołania create za pomocą parametrów meta_ i nie mogą być zmieniane po utworzeniu spotkania.

Wskazówki

Połącz updateRecordings z punktem końcowym getRecordings, aby zbudować przeszukiwalne archiwum nagrań. Dodaj metadane, takie jak nazwisko prezentera, dział lub semestr, a następnie użyj filtra meta_ w getRecordings, aby pobierać nagrania według tych pól.

  • Możesz zaktualizować wiele nagrań jednocześnie, przekazując rozdzieloną przecinkami listę identyfikatorów do parametru recordID.
  • Istniejące wpisy metadanych, które nie zostały wymienione w wywołaniu, pozostają bez zmian — nie musisz za każdym razem ponownie wysyłać wszystkich metadanych.
  • Aby usunąć konkretny wpis metadanych, przekaż klucz z pustą wartością. To jedyny sposób na usunięcie poszczególnych pól metadanych.
  • Format klucza metadanych jest identyczny z używanym w wywołaniu create: meta_yourKeyName=yourValue.

Najczęściej zadawane pytania

Tak. Przekaż rozdzieloną przecinkami listę identyfikatorów nagrań do parametru recordID. Te same zmiany metadanych zostaną zastosowane do wszystkich wskazanych nagrań w jednym wywołaniu.

Pozostają bez zmian. Punkt końcowy updateRecordings modyfikuje tylko te wpisy metadanych, które jawnie uwzględnisz w żądaniu. Wszystkie pozostałe istniejące metadane są zachowywane.

Przekaż klucz metadanych z pustą wartością. Na przykład meta_category= (bez wartości po znaku równości) usunie wpis metadanych category z nagrania.

Nie. Serwer wyszukuje nagrania tylko w stanach published i unpublished. Usuniętych nagrań nie można znaleźć ani zaktualizować. Jeśli nagranie zostało usunięte, otrzymasz błąd notFound.

Nie. Punkt końcowy updateRecordings nie jest zaimplementowany na bbbserver.de. Na tej platformie metadane muszą zostać ustawione podczas początkowego wywołania create i nie mogą być później modyfikowane.