Capitolo 5 GET POST

end – Termina riunione

L'endpoint end termina immediatamente una riunione BigBlueButton in esecuzione. Tutti i partecipanti vengono rimossi dalla conferenza e, se la registrazione era abilitata, la pipeline di elaborazione della registrazione viene attivata automaticamente.

Endpoint

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/end?<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
meetingID String Obbligatorio. L'ID della riunione da terminare. Deve corrispondere all'ID usato quando la riunione è stata creata.

Parametri opzionali

Parametro Tipo Descrizione
password String Deprecated La password del moderatore. Questo parametro non è più richiesto da BigBlueButton 3.0 — il solo checksum è sufficiente per l'autenticazione.

Esempio di richiesta

Richiesta POST con cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/end" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "meetingID=replace-with-meeting-id&checksum=replace-with-checksum"

Risposta di esempio

Successo

<response>
  <returncode>SUCCESS</returncode>
  <messageKey>sentEndMeetingRequest</messageKey>
  <message>A request to end the meeting was sent. Please wait a few seconds,
    and then use the getMeetingInfo or isMeetingRunning API calls to verify
    that it was ended.</message>
</response>

Errore — Riunione non trovata

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

Note su bbbserver.de

bbbserver.de: Il parametro duration nella chiamata create non termina automaticamente le riunioni su bbbserver.de. Se devi terminare una riunione dopo un tempo specifico, devi inviare manualmente una chiamata API end al momento desiderato (ad esempio tramite un timer o cron job nella tua applicazione).

Comportamento importante

La chiamata end è asincrona. La risposta conferma che la richiesta è stata ricevuta, non che la riunione sia stata completamente terminata. La tempistica esatta del processo di chiusura non è ufficialmente specificata.

Invia la chiamata API end al server.

Attendi alcuni secondi affinché la riunione venga chiusa.

Verifica che la riunione sia terminata chiamando getMeetingInfo o isMeetingRunning.

Suggerimenti

Se imposti il parametro meta_endCallbackUrl durante create, BigBlueButton invierà una callback all'URL specificato quando la riunione termina. Usalo per attivare automaticamente i flussi di lavoro post-riunione.

  • Se la registrazione era abilitata, l'elaborazione della registrazione inizia automaticamente dopo la fine della riunione.
  • Una riunione terminata non può essere ripresa — devi creare una nuova riunione.
  • Da BigBlueButton 3.0, il parametro password non è più richiesto. Il checksum fornisce un'autenticazione sufficiente.

Domande frequenti

Tutti i partecipanti vengono immediatamente rimossi dalla conferenza. Vedranno una notifica che informa che la riunione è stata terminata da un moderatore o da un amministratore.

No. Una volta terminata una riunione, non può essere ripresa. Devi creare una nuova riunione usando la chiamata API create. Se lo desideri, puoi riutilizzare lo stesso meetingID.

No. Da BigBlueButton 3.0, il parametro password è deprecato e non è più richiesto. Il checksum è sufficiente per l'autenticazione. Le versioni più vecchie potrebbero richiedere ancora la password del moderatore.

La chiamata end è asincrona. Sebbene la risposta venga in genere restituita entro pochi millisecondi, il processo effettivo di chiusura può richiedere alcuni secondi. La tempistica esatta non è ufficialmente specificata. Usa getMeetingInfo o isMeetingRunning per verificarlo.

Se la registrazione era abilitata per la riunione, la pipeline di elaborazione della registrazione viene attivata automaticamente al termine della riunione. La registrazione sarà disponibile dopo il completamento dell'elaborazione, operazione che può richiedere diversi minuti a seconda della durata della riunione.