Kapitel 5 GET POST

end – Afslut møde

end-endpointet afslutter straks et kørende BigBlueButton-møde. Alle deltagere fjernes fra konferencen, og hvis optagelse var aktiveret, udløses behandlingspipelinen for optagelsen automatisk.

Endepunkt

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

Både GET og POST metoder understøttes. Ved brug af POST skal parametre sendes som application/x-www-form-urlencoded i request body.

Obligatoriske parametre

Parameter Type Beskrivelse
meetingID String Påkrævet. Møde-ID'et for det møde, der skal afsluttes. Skal matche det ID, der blev brugt, da mødet blev oprettet.

Valgfrie parametre

Parameter Type Beskrivelse
password String Deprecated Moderatoradgangskoden. Denne parameter er ikke længere påkrævet siden BigBlueButton 3.0 — checksum alene er tilstrækkelig til autentifikation.

Eksempel på anmodning

POST-request med 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"

Eksempelsvar

Succes

<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>

Fejl — Møde ikke fundet

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

bbbserver.de Noter

bbbserver.de: Parameteren duration i create-kaldet afslutter ikke automatisk møder på bbbserver.de. Hvis du har brug for at afslutte et møde efter et bestemt tidsrum, skal du sende et end-API-kald manuelt på det ønskede tidspunkt (for eksempel via en timer eller cron job i din applikation).

Vigtig adfærd

end-kaldet er asynkront. Svaret bekræfter, at requesten blev modtaget, ikke at mødet er fuldt afsluttet. Den præcise timing af nedlukningsprocessen er ikke officielt specificeret.

Send end-API-kaldet til serveren.

Vent et par sekunder, mens mødet lukkes ned.

Bekræft, at mødet er afsluttet, ved at kalde getMeetingInfo eller isMeetingRunning.

Tips

Hvis du angiver parameteren meta_endCallbackUrl under create, vil BigBlueButton sende et callback til den angivne URL, når mødet afsluttes. Brug dette til automatisk at udløse workflows efter mødet.

  • Hvis optagelse var aktiveret, starter behandlingen af optagelsen automatisk, efter at mødet er afsluttet.
  • Et møde, der er blevet afsluttet, kan ikke genoptages — du skal oprette et nyt møde.
  • Siden BigBlueButton 3.0 er parameteren password ikke længere påkrævet. checksum giver tilstrækkelig autentifikation.

Ofte stillede spørgsmål

Alle deltagere fjernes straks fra konferencen. De vil se en meddelelse om, at mødet er blevet afsluttet af en moderator eller administrator.

Nej. Når et møde først er blevet afsluttet, kan det ikke genoptages. Du skal oprette et nyt møde ved hjælp af create-API-kaldet. Du kan genbruge samme meetingID, hvis det ønskes.

Nej. Siden BigBlueButton 3.0 er parameteren password forældet og ikke længere påkrævet. checksum er tilstrækkelig til autentifikation. Ældre versioner kan stadig kræve moderatoradgangskoden.

end-kaldet er asynkront. Selvom svaret typisk returneres inden for millisekunder, kan den faktiske nedlukningsproces tage et par sekunder. Den præcise timing er ikke officielt specificeret. Brug getMeetingInfo eller isMeetingRunning til at verificere det.

Hvis optagelse var aktiveret for mødet, udløses behandlingsprocessen for optagelsen automatisk, når mødet slutter. Optagelsen bliver tilgængelig, når behandlingen er fuldført, hvilket kan tage flere minutter afhængigt af mødets længde.