Hoofdstuk 5 GET POST

end – Vergadering beëindigen

Het end-endpoint beëindigt onmiddellijk een actieve BigBlueButton-vergadering. Alle deelnemers worden uit de conferentie verwijderd en als opname was ingeschakeld, wordt de verwerkingspipeline voor opnames automatisch gestart.

Endpoint

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

Zowel GET als POST worden ondersteund. Bij gebruik van POST stuur je parameters als application/x-www-form-urlencoded in de requestbody.

Vereiste parameters

Parameter Type Beschrijving
meetingID String Vereist. De meeting-ID van de meeting die moet worden beëindigd. Moet overeenkomen met de ID die is gebruikt toen de meeting werd aangemaakt.

Optionele parameters

Parameter Type Beschrijving
password String Deprecated Het moderatorwachtwoord. Deze parameter is niet langer vereist sinds BigBlueButton 3.0 — alleen de checksum is voldoende voor authenticatie.

Voorbeeldverzoek

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

Voorbeeldrespons

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>

Fout — Meeting niet gevonden

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

bbbserver.de Opmerkingen

bbbserver.de: De parameter duration in de create-call beëindigt vergaderingen op nietbbbserver.de automatisch. Als je een vergadering na een bepaalde tijd wilt beëindigen, moet je op het gewenste moment handmatig een end-API-call sturen (bijvoorbeeld via een timer of cron job in je applicatie).

Belangrijk gedrag

De end-call is asynchroon. De response bevestigt dat het verzoek is ontvangen, niet dat de vergadering volledig is beëindigd. De exacte timing van het afsluitproces is niet officieel gespecificeerd.

Stuur de end-API-aanroep naar de server.

Wacht een paar seconden tot de meeting is afgesloten.

Controleer of de meeting is beëindigd door getMeetingInfo of isMeetingRunning aan te roepen.

Tips

Als je de parameter meta_endCallbackUrl hebt ingesteld tijdens create, stuurt BigBlueButton een callback naar de door jou opgegeven URL wanneer de vergadering eindigt. Gebruik dit om workflows na de vergadering automatisch te starten.

  • Als opname was ingeschakeld, start de opnameverwerking automatisch nadat de meeting is beëindigd.
  • Een meeting die is beëindigd kan niet worden hervat — je moet een nieuwe meeting aanmaken.
  • Sinds BigBlueButton 3.0 is de parameter password niet langer vereist. De checksum biedt voldoende authenticatie.

Veelgestelde vragen

Alle deelnemers worden onmiddellijk uit de conferentie verwijderd. Zij zien een melding dat de meeting is beëindigd door een moderator of beheerder.

Nee. Zodra een vergadering is beëindigd, kan deze niet worden hervat. Je moet een nieuwe vergadering aanmaken met de create-API-call. Je kunt desgewenst dezelfde meetingID hergebruiken.

Nee. Sinds BigBlueButton 3.0 is de parameter password verouderd en niet langer vereist. De checksum is voldoende voor authenticatie. Oudere versies kunnen nog steeds het moderatorwachtwoord vereisen.

De end-call is asynchroon. Hoewel de response doorgaans binnen milliseconden wordt teruggegeven, kan het daadwerkelijke afsluitproces enkele seconden duren. De exacte timing is niet officieel gespecificeerd. Gebruik getMeetingInfo of isMeetingRunning om dit te controleren.

Als opnemen was ingeschakeld voor de vergadering, wordt de verwerkingspipeline voor opnames automatisch gestart zodra de vergadering eindigt. De opname wordt beschikbaar nadat de verwerking is voltooid, wat afhankelijk van de lengte van de vergadering enkele minuten kan duren.