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 містить такі поля:

Типові сценарії використання

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

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