Глава 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 подходит для простого опроса статуса, для более эффективного мониторинга в реальном времени стоит использовать webhooks. Частый опрос этой конечной точки создаёт ненужную нагрузку на сервер.

Не полагайтесь только на isMeetingRunning для подробного статуса встречи. Вместо этого используйте getMeetingInfo, если вам нужны количество участников, статус записи или другие метаданные.

  • Используйте этот endpoint для лёгких проверок работоспособности или простых панелей мониторинга, которым нужно знать только то, активна ли встреча.
  • Комбинируйте её с getMeetings, если вам нужно отслеживать несколько встреч одновременно — один вызов getMeetings эффективнее, чем множество отдельных вызовов isMeetingRunning.
  • Сохраняйте разумный интервал опроса (например, каждые 30–60 секунд), чтобы не создавать ненужную нагрузку на сервер.

Часто задаваемые вопросы

Конечная точка всё равно возвращает SUCCESS с running, установленным в false. Она не выдаёт ошибку для неизвестных идентификаторов встреч.

Нет. Встреча считается запущенной только после того, как к ней присоединился хотя бы один участник. Встреча, которая была создана, но не имеет участников, возвращает running как false.

Для простых проверок статуса — да. Однако для событийного мониторинга в реальном времени webhooks являются более эффективной альтернативой, поскольку они отправляют обновления в ваше приложение, а не требуют повторяющегося опроса.

isMeetingRunning возвращает только логическое значение, указывающее, активна ли встреча. getMeetingInfo возвращает исчерпывающие сведения, включая списки участников, статус записи, метаданные и многое другое. Используйте isMeetingRunning, когда вам нужен только быстрый ответ «да» или «нет».

Да. API BigBlueButton принимает как запросы GET, так и POST для isMeetingRunning. Параметры и ответ одинаковы независимо от используемого HTTP-метода.
Руководство по API BigBlueButton