Capitolo 14 GET POST

updateRecordings – Aggiorna metadati

L'endpoint updateRecordings ti consente di aggiungere, modificare o rimuovere metadati su una o più registrazioni esistenti. Questo è utile per etichettare le registrazioni dopo la fine di una riunione — ad esempio aggiungendo il nome del relatore, una categoria o un identificatore del corso — senza rielaborare la registrazione stessa.

Endpoint

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

Sono supportati sia i metodi GET che POST. Quando usi POST, invia i parametri come application/x-www-form-urlencoded nel corpo della richiesta.

Parametri obbligatori

Parametro Tipo Descrizione
recordID String Obbligatorio. Un elenco di ID di registrazione separati da virgole i cui metadati devono essere aggiornati. Puoi aggiornare più registrazioni in una singola chiamata separando gli ID con virgole.

Parametri opzionali

Parametro Tipo Descrizione
meta_<key> String Una o più coppie chiave-valore di metadati. Un valore non vuoto imposta o aggiorna la voce di metadati. Un valore vuoto rimuove completamente la voce di metadati. Il nome della chiave segue lo stesso formato usato nella chiamata create.

Come funzionano gli aggiornamenti dei metadati

Passa uno o più parametri meta_<key> con un valore non vuoto per impostare o aggiornare la voce di metadati corrispondente.

Passa un parametro meta_<key> con un valore vuoto per rimuovere quella voce di metadati.

Tutte le voci di metadati esistenti che non sono incluse nella chiamata rimangono invariate.

Esempio di richiesta

Impostazione dei metadati

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

Rimozione dei metadati

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

Richiesta POST con 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"

Risposta di esempio

Successo

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

Errore — recordID mancante

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

Errore — Registrazione non trovata

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

Risposte di errore

Chiave del messaggio Descrizione
checksumError Il checksum non è valido o non corrisponde al valore previsto.
missingParamRecordID Il parametro obbligatorio recordID non è stato fornito.
notFound Non è stata trovata alcuna registrazione con l'ID specificato. Il server cerca solo nelle registrazioni published e unpublished — le registrazioni eliminate non possono essere aggiornate.

bbbserver.de Note

bbbserver.de: L'endpoint updateRecordings è non disponibile su bbbserver.de. I metadati devono essere impostati durante la chiamata create usando i parametri meta_ e non possono essere modificati dopo la creazione della riunione.

Suggerimenti

Combina updateRecordings con l'endpoint getRecordings per creare un archivio ricercabile delle registrazioni. Aggiungi metadati come il nome del relatore, il dipartimento o il semestre, quindi usa il filtro meta_ in getRecordings per recuperare le registrazioni in base a questi campi.

  • Puoi aggiornare più registrazioni contemporaneamente passando un elenco di ID separati da virgole al parametro recordID.
  • Le voci di metadati esistenti che non sono menzionate nella chiamata rimangono invariate — non è necessario reinviare tutti i metadati ogni volta.
  • Per rimuovere una voce di metadati specifica, passa la chiave con un valore vuoto. Questo è l'unico modo per eliminare singoli campi di metadati.
  • Il formato della chiave dei metadati è identico a quello usato nella chiamata create: meta_yourKeyName=yourValue.

Domande frequenti

Sì. Passa un elenco di ID di registrazione separati da virgole al parametro recordID. Le stesse modifiche ai metadati verranno applicate a tutte le registrazioni specificate in un'unica chiamata.

Rimangono invariati. L'endpoint updateRecordings modifica solo le voci di metadati che includi esplicitamente nella richiesta. Tutti gli altri metadati esistenti vengono mantenuti.

Passa la chiave dei metadati con un valore vuoto. Ad esempio, meta_category= (senza alcun valore dopo il segno di uguale) rimuoverà la voce di metadati category dalla registrazione.

No. Il server cerca solo registrazioni negli stati published e unpublished. Le registrazioni eliminate non possono essere trovate né aggiornate. Riceverai un errore notFound se la registrazione è stata eliminata.

No. L'endpoint updateRecordings non è implementato su bbbserver.de. Su quella piattaforma, i metadati devono essere impostati durante la chiamata iniziale create e non possono essere modificati successivamente.