getMeetings – Список всех встреч

Конечная точка getMeetings возвращает список всех встреч, существующих в данный момент на сервере BigBlueButton, включая сведения об участниках и метаданные. Это основной инструмент для построения административных панелей, мониторинга нагрузки сервера и планирования ёмкости всей вашей инфраструктуры.

Конечная точка

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/getMeetings?checksum=replace-with-checksum

Параметры

Пример запроса

https://api-guide.bbbserver.com/bigbluebutton/api/getMeetings?checksum=replace-with-checksum

Пример ответа

Встречи найдены

<response>
  <returncode>SUCCESS</returncode>
  <meetings>
    <meeting>
      <meetingName>Demo Meeting</meetingName>
    <meetingID>replace-with-meeting-id</meetingID>
      <internalMeetingID>a0715c95...</internalMeetingID>
      <createTime>1531241258036</createTime>
      <createDate>Tue Jul 10 16:47:38 UTC 2018</createDate>
      <voiceBridge>70066</voiceBridge>
      <dialNumber>613-555-1234</dialNumber>
      <attendeePW>ap</attendeePW>
      <moderatorPW>mp</moderatorPW>
      <running>true</running>
      <duration>0</duration>
      <hasUserJoined>true</hasUserJoined>
      <recording>false</recording>
      <hasBeenForciblyEnded>false</hasBeenForciblyEnded>
      <startTime>1531241258074</startTime>
      <endTime>0</endTime>
      <participantCount>5</participantCount>
      <listenerCount>2</listenerCount>
      <voiceParticipantCount>3</voiceParticipantCount>
      <videoCount>2</videoCount>
      <maxUsers>0</maxUsers>
      <moderatorCount>1</moderatorCount>
      <attendees>
        <attendee>
          <userID>w_ftcrsyuh44oj</userID>
          <fullName>Max Mustermann</fullName>
          <role>MODERATOR</role>
          <isPresenter>true</isPresenter>
          <isListeningOnly>false</isListeningOnly>
          <hasJoinedVoice>true</hasJoinedVoice>
          <hasVideo>true</hasVideo>
          <clientType>HTML5</clientType>
        </attendee>
      </attendees>
      <metadata/>
      <isBreakout>false</isBreakout>
    </meeting>
  </meetings>
</response>

Встречи не найдены

<response>
  <returncode>SUCCESS</returncode>
  <meetings/>
  <messageKey>noMeetings</messageKey>
  <message>no meetings were found on this server</message>
</response>

Поля ответа для каждой встречи

Сведения об участнике

Каждая запись в списке attendees содержит следующие поля:

Распространённые сценарии использования

• Панель администратора — отображает обзор всех запущенных встреч и количество их участников.
• Планирование емкости — вычисляет общее количество активных участников во всех встречах на сервере.
• Мониторинг — помогает выявлять встречи без модератора или встречи, в которых возникли проблемы.
• Автоматическая очистка — позволяет находить встречи, которые существуют уже долгое время без участников.

Советы и лучшие практики