Rozdział 5 GET POST

end – Zakończ spotkanie

Punkt końcowy end natychmiast kończy trwające spotkanie BigBlueButton. Wszyscy uczestnicy są usuwani z konferencji, a jeśli nagrywanie było włączone, potok przetwarzania nagrania zostaje uruchomiony automatycznie.

Punkt końcowy

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

Obsługiwane są zarówno metody GET, jak i POST. W przypadku użycia POST wyślij parametry jako application/x-www-form-urlencoded w treści żądania.

Wymagane parametry

Parametr Typ Opis
meetingID String Wymagane. Identyfikator spotkania, które ma zostać zakończone. Musi odpowiadać identyfikatorowi użytemu podczas tworzenia spotkania.

Parametry opcjonalne

Parametr Typ Opis
password String Deprecated Hasło moderatora. Ten parametr nie jest już wymagany od wersji BigBlueButton 3.0 — samo checksum wystarcza do uwierzytelnienia.

Przykładowe żądanie

Żądanie POST z użyciem 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"

Przykładowa odpowiedź

Sukces

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

Błąd — nie znaleziono spotkania

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

Uwagi dotyczące bbbserver.de

bbbserver.de: Parametr duration w wywołaniu create nie kończy automatycznie spotkań na bbbserver.de. Jeśli chcesz zakończyć spotkanie po określonym czasie, musisz ręcznie wysłać wywołanie API end w odpowiednim momencie (na przykład za pomocą timera lub cron job w swojej aplikacji).

Ważne zachowanie

Wywołanie end jest asynchroniczne. Odpowiedź potwierdza, że żądanie zostało odebrane, a nie że spotkanie zostało już całkowicie zakończone. Dokładny czas procesu zamykania nie jest oficjalnie określony.

Wyślij do serwera wywołanie API end.

Odczekaj kilka sekund, aż spotkanie zostanie zamknięte.

Sprawdź, czy spotkanie zostało zakończone, wywołując getMeetingInfo lub isMeetingRunning.

Wskazówki

Jeśli podczas create ustawisz parametr meta_endCallbackUrl, BigBlueButton wyśle callback na podany przez Ciebie URL po zakończeniu spotkania. Użyj tego, aby automatycznie uruchamiać procesy po spotkaniu.

  • Jeśli nagrywanie było włączone, przetwarzanie nagrania rozpocznie się automatycznie po zakończeniu spotkania.
  • Spotkania, które zostało zakończone, nie można wznowić — musisz utworzyć nowe spotkanie.
  • Od wersji BigBlueButton 3.0 parametr password nie jest już wymagany. checksum zapewnia wystarczające uwierzytelnienie.

Najczęściej zadawane pytania

Wszyscy uczestnicy są natychmiast usuwani z konferencji. Zobaczą powiadomienie, że spotkanie zostało zakończone przez moderatora lub administratora.

Nie. Po zakończeniu spotkania nie można go wznowić. Musisz utworzyć nowe spotkanie za pomocą wywołania API create. Jeśli chcesz, możesz ponownie użyć tego samego meetingID.

Nie. Od wersji BigBlueButton 3.0 parametr password jest przestarzały i nie jest już wymagany. checksum wystarcza do uwierzytelnienia. Starsze wersje mogą nadal wymagać hasła moderatora.

Wywołanie end jest asynchroniczne. Chociaż odpowiedź jest zwykle zwracana w ciągu milisekund, rzeczywisty proces zamykania może potrwać kilka sekund. Dokładny czas nie jest oficjalnie określony. Użyj getMeetingInfo lub isMeetingRunning, aby to zweryfikować.

Jeśli dla spotkania włączono nagrywanie, po zakończeniu spotkania automatycznie uruchamiany jest proces przetwarzania nagrania. Nagranie będzie dostępne po zakończeniu przetwarzania, co może potrwać kilka minut w zależności od długości spotkania.