Розділ 8 GET POST

isMeetingRunning – Перевірити статус зустрічі

Кінцева точка isMeetingRunning перевіряє, чи є конкретна зустріч наразі активною на сервері BigBlueButton. Вона повертає просте булеве значення, що робить її найлегшим викликом для моніторингу в API.

Ендпоінт

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

Ця кінцева точка завжди повертає код SUCCESS, навіть якщо наданий ідентифікатор зустрічі не існує. У такому разі значення running буде просто false.

Обов’язкові параметри

Параметр Тип Обов’язково Опис
meetingID String Так ID зустрічі, яку ви хочете перевірити.

Приклад запиту

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

Приклад відповіді

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

Поля відповіді

Поле Тип Опис
returncode String Завжди SUCCESS для цієї кінцевої точки, незалежно від того, чи існує зустріч.
running Boolean true, якщо зустріч зараз активна; false, якщо вона не активна або ідентифікатор зустрічі невідомий.

Коли зустріч вважається активною?

Зустріч вважається активною, щойно до неї приєднався хоча б один учасник. Щойно створена зустріч без учасників поверне running як false, навіть якщо вона існує на сервері.

Викличте create, щоб створити нову зустріч на сервері.

На цьому етапі isMeetingRunning повертає false — ще ніхто не приєднався.

Учасник приєднується через join. Зустріч тепер активна.

isMeetingRunning тепер повертає true.

Примітки для користувачів bbbserver.de

На керованих екземплярах bbbserver.de контрольна сума API обчислюється автоматично, якщо ви використовуєте вбудовані інструменти API. Вам не потрібно обчислювати її вручну.

Поради та найкращі практики

Хоча isMeetingRunning підходить для простого опитування стану, для ефективнішого моніторингу в реальному часі варто розглянути використання вебхуків. Часте опитування цієї кінцевої точки створює зайве навантаження на сервер.

Не покладайтеся лише на isMeetingRunning для детального стану зустрічі. Якщо вам потрібні кількість учасників, статус запису або інші метадані, використовуйте getMeetingInfo.

  • Використовуйте цей ендпоінт для легких перевірок працездатності або простих дашбордів, яким потрібно знати лише, чи є зустріч активною.
  • Поєднуйте її з getMeetings, якщо вам потрібно одночасно відстежувати кілька зустрічей — один виклик getMeetings ефективніший, ніж багато окремих викликів isMeetingRunning.
  • Підтримуйте розумний інтервал опитування (наприклад, кожні 30–60 секунд), щоб уникнути зайвого навантаження на сервер.

Поширені запитання

Кінцева точка все одно повертає SUCCESS із running, встановленим у false. Вона не генерує помилку для невідомих ідентифікаторів зустрічей.

Ні. Зустріч вважається активною лише після того, як до неї приєднався хоча б один учасник. Зустріч, яка була створена, але не має учасників, повертає running як false.

Для простих перевірок статусу — так. Однак для моніторингу в реальному часі на основі подій ефективнішою альтернативою є вебхуки, оскільки вони надсилають оновлення до вашого застосунку замість того, щоб вимагати повторного опитування.

isMeetingRunning повертає лише булеве значення, що вказує, чи активна зустріч. getMeetingInfo повертає вичерпні відомості, включно зі списками учасників, статусом запису, метаданими тощо. Використовуйте isMeetingRunning, коли вам потрібна лише швидка відповідь так або ні.

Так. API BigBlueButton приймає як запити GET, так і POST для isMeetingRunning. Параметри та відповідь ідентичні незалежно від використаного HTTP-методу.
Посібник з API BigBlueButton