Przeglądasz dokumentację API dla BigBlueButton 3.x. Aktualna wersja to BigBlueButton 4.x. Planujesz aktualizację? Przewodnik migracji zawiera wszystkie zmiany wymagane w wywołaniach API.
isMeetingRunning – Sprawdź status spotkania
Punkt końcowy isMeetingRunning sprawdza, czy konkretne spotkanie jest obecnie aktywne na serwerze BigBlueButton. Zwraca prostą wartość logiczną, co czyni go najlżejszym wywołaniem monitorującym dostępnym w API.
Punkt końcowy
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum Dla każdego prawidłowego żądania ten punkt końcowy zwraca kod SUCCESS, nawet jeśli spotkanie o podanym identyfikatorze nie istnieje. W takim przypadku wartość running wynosi po prostu false.
Wymagane parametry
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
meetingID | String | Tak | Identyfikator spotkania, które chcesz sprawdzić. |
Przykładowe żądanie
https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum Przykładowa odpowiedź
<response>
<returncode>SUCCESS</returncode>
<running>true</running>
</response> Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
returncode | String | SUCCESS dla każdego prawidłowego żądania, niezależnie od tego, czy spotkanie istnieje. |
running | Boolean | true, jeśli spotkanie jest obecnie uruchomione, false, jeśli nie jest uruchomione lub identyfikator spotkania jest nieznany. |
Kiedy spotkanie jest uznawane za uruchomione?
Spotkanie jest uznawane za uruchomione, gdy dołączy co najmniej jeden uczestnik. Świeżo utworzone spotkanie bez uczestników zwróci running jako false, mimo że istnieje na serwerze.
Wywołaj create, aby utworzyć nowe spotkanie na serwerze.
W tym momencie isMeetingRunning zwraca false — nikt jeszcze nie dołączył.
Uczestnik dołącza przez join. Spotkanie jest teraz uruchomione.
isMeetingRunning zwraca teraz true.
Wskazówki i najlepsze praktyki
Chociaż isMeetingRunning nadaje się do prostego odpytywania o stan, rozważ użycie webhooków do bardziej wydajnego monitorowania w czasie rzeczywistym. Częste odpytywanie tego punktu końcowego powoduje niepotrzebne obciążenie serwera.
Nie polegaj wyłącznie na isMeetingRunning w przypadku szczegółowego statusu spotkania. Użyj zamiast tego getMeetingInfo, jeśli potrzebujesz liczby uczestników, statusu nagrywania lub innych metadanych.
- Używaj tego endpointu do lekkich kontroli stanu lub prostych pulpitów, które muszą wiedzieć tylko, czy spotkanie jest aktywne.
- Połącz to z
getMeetings, jeśli musisz monitorować wiele spotkań naraz — pojedyncze wywołaniegetMeetingsjest bardziej wydajne niż wiele indywidualnych wywołańisMeetingRunning. - Utrzymuj rozsądny interwał odpytywania (np. co 30 do 60 sekund), aby uniknąć niepotrzebnego obciążania serwera.
Najczęściej zadawane pytania
SUCCESS z ustawieniem running na false. Nie generuje błędu dla nieznanych identyfikatorów spotkań.false.isMeetingRunning zwraca tylko wartość logiczną wskazującą, czy spotkanie jest aktywne. getMeetingInfo zwraca szczegółowe informacje, w tym listy uczestników, status nagrywania, metadane i inne. Używaj isMeetingRunning, gdy potrzebujesz tylko szybkiej odpowiedzi tak lub nie.BigBlueButton akceptuje zarówno żądania GET, jak i POST dla isMeetingRunning. Parametry i odpowiedź są identyczne niezależnie od użytej metody HTTP.