Capitolo 12 GET POST

publishRecordings – Pubblica/Annulla pubblicazione

L'endpoint publishRecordings commuta la visibilità di una o più registrazioni. Puoi pubblicare le registrazioni per renderle accessibili tramite il loro URL di riproduzione, oppure annullarne la pubblicazione per nasconderle ai visualizzatori mantenendo i file sul server.

Endpoint

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings?<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

Parametro Tipo Descrizione
recordID String Obbligatorio. Un elenco di ID registrazione separati da virgole da pubblicare o di cui annullare la pubblicazione. Puoi specificare uno o più ID in una singola richiesta.
publish Boolean Obbligatorio. Impostare su true per pubblicare le registrazioni (renderle accessibili), oppure su false per annullarne la pubblicazione (nasconderle agli spettatori).

Esempio di richiesta

Pubblicare una singola registrazione

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

Annullare la pubblicazione di più registrazioni

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

Richiesta POST con cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&publish=true&checksum=replace-with-checksum"

Risposta di esempio

Successo

<response>
  <returncode>SUCCESS</returncode>
  <published>true</published>
</response>

Errore — Registrazione non trovata

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find recordings.</message>
</response>

Risposte di errore

messageKey Descrizione
checksumError Il checksum non è valido. Verifica di usare il secret condiviso corretto e che l'algoritmo checksum corrisponda alla configurazione del server.
missingParamRecordID Il parametro obbligatorio recordID non è stato fornito.
missingParamPublish Il parametro obbligatorio publish non è stato fornito.
notFound Non è stata trovata alcuna registrazione corrispondente a nessuno degli ID registrazione specificati.

Suggerimenti

Usa l'endpoint getRecordings per recuperare lo stato di pubblicazione attuale delle tue registrazioni prima di modificarne la visibilità. Il campo published nella risposta indica se ogni registrazione è attualmente visibile.

  • Una registrazione pubblicata è accessibile tramite il suo URL di riproduzione. Una registrazione non pubblicata rimane sul server ma non può essere accessibile agli spettatori.
  • Questa azione è completamente reversibile: le registrazioni possono essere pubblicate e ritirate dalla pubblicazione un numero illimitato di volte.
  • Puoi elaborare in batch più registrazioni passando un elenco di ID registrazione separati da virgole in una singola richiesta.
  • Se vuoi rimuovere definitivamente una registrazione invece di limitarne l'occultamento, usa l'endpoint deleteRecordings.

Quando passi più ID di registrazione e almeno uno di essi è valido, la chiamata restituirà SUCCESS. Solo se nessuno degli ID forniti corrisponde a una registrazione esistente il server restituirà FAILED con l'errore notFound.

Domande frequenti

Annullare la pubblicazione di una registrazione la nasconde agli spettatori ma mantiene i file della registrazione sul server. Puoi ripubblicarla in qualsiasi momento. Eliminare una registrazione rimuove definitivamente i file dal server e non può essere annullato.

Sì. Passa un elenco di ID di registrazione separati da virgole nel parametro recordID. Tutte le registrazioni specificate verranno impostate nello stesso stato di pubblicazione in un'unica richiesta.

Se almeno uno degli ID di registrazione forniti è valido, la chiamata restituisce SUCCESS e applica la modifica a tutte le registrazioni valide. Il server restituisce FAILED con notFound solo se nessuno degli ID corrisponde a una registrazione esistente.

Usa l'endpoint getRecordings e controlla il campo published nell'XML di risposta. Sarà impostato su true per le registrazioni pubblicate e su false per quelle non pubblicate.

Annullare la pubblicazione di una registrazione rende il suo URL di riproduzione inaccessibile. Gli utenti che stanno visualizzando la registrazione in quel momento potrebbero subire un'interruzione a seconda di come il client di riproduzione gestisce il cambiamento.