Kapitel 8 GET POST

isMeetingRunning – Kontroller mødestatus

Endepunktet isMeetingRunning kontrollerer, om et bestemt møde aktuelt er aktivt på BigBlueButton-serveren. Det returnerer en simpel boolesk værdi, hvilket gør det til det letteste overvågningskald i API'et.

Endepunkt

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum

Dette endepunkt returnerer altid en returkode på SUCCESS, selv hvis det angivne møde-ID ikke findes. I så fald er værdien for running blot false.

Obligatoriske parametre

Parameter Type Påkrævet Beskrivelse
meetingID String Ja Møde-ID'et for det møde, du vil kontrollere.

Eksempel på anmodning

https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum

Eksempelsvar

<response>
  <returncode>SUCCESS</returncode>
  <running>true</running>
</response>

Svarfelter

Felt Type Beskrivelse
returncode String Altid SUCCESS for dette endepunkt, uanset om mødet findes.
running Boolean true, hvis mødet kører i øjeblikket, false, hvis det ikke kører, eller hvis møde-ID'et er ukendt.

Hvornår betragtes et møde som kørende?

Et møde betragtes som kørende, så snart mindst én deltager har deltaget. Et nyoprettet møde uden deltagere vil returnere running som false, selvom det findes på serveren.

Kald create for at oprette et nyt møde på serveren.

På dette tidspunkt returnerer isMeetingRunning false — ingen har tilsluttet sig endnu.

En deltager tilslutter sig via join. Mødet kører nu.

isMeetingRunning returnerer nu true.

Bemærkninger til bbbserver.de-brugere

På administrerede bbbserver.de-instanser beregnes API-tjeksummen automatisk, når du bruger de indbyggede API-værktøjer. Du behøver ikke at beregne den manuelt.

Tips og bedste praksis

Selvom isMeetingRunning er velegnet til enkel status-polling, bør du overveje at bruge webhooks til mere effektiv realtidsovervågning. Polling af dette endepunkt med høj frekvens lægger unødig belastning på serveren.

Stol ikke alene på isMeetingRunning for detaljeret mødestatus. Brug i stedet getMeetingInfo, hvis du har brug for deltagerantal, optagelsesstatus eller andre metadata.

  • Brug dette endpoint til letvægts-sundhedstjek eller enkle dashboards, der kun behøver at vide, om et møde er aktivt.
  • Kombinér det med getMeetings, hvis du har brug for at overvåge flere møder på én gang — ét enkelt kald til getMeetings er mere effektivt end mange individuelle kald til isMeetingRunning.
  • Hold dit forespørgselsinterval rimeligt (f.eks. hvert 30. til 60. sekund) for at undgå at belaste serveren unødigt.

Ofte stillede spørgsmål

Endepunktet returnerer stadig SUCCESS med running sat til false. Det giver ikke en fejl for ukendte møde-ID'er.

Nej. Et møde betragtes først som kørende, når mindst én deltager har deltaget. Et møde, der er oprettet, men ikke har deltagere, returnerer running som false.

Til simple statuskontroller, ja. Til overvågning i realtid baseret på hændelser er webhooks dog et mere effektivt alternativ, da de sender opdateringer til din applikation i stedet for at kræve gentagen polling.

isMeetingRunning returnerer kun en boolesk værdi, der angiver, om mødet er aktivt. getMeetingInfo returnerer omfattende detaljer, herunder deltagerlister, optagelsesstatus, metadata og mere. Brug isMeetingRunning, når du kun har brug for et hurtigt ja-eller-nej-svar.

Ja. BigBlueButton-API'et accepterer både GET- og POST-anmodninger for isMeetingRunning. Parametrene og svaret er identiske uanset den anvendte HTTP-metode.