getMeetingInfo – Отримати деталі зустрічі

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

Ендпоінт

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

Параметри

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

Успішна відповідь містить такі поля, що описують зустріч та її поточний стан:

Поля учасника

Кожен елемент attendee у межах attendees містить такі поля:

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

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

Приклад відповіді (успіх)

<response>
  <returncode>SUCCESS</returncode>
  <meetingName>Project Discussion</meetingName>
    <meetingID>replace-with-meeting-id</meetingID>
    <internalMeetingID>replace-with-internal-meeting-id</internalMeetingID>
  <createTime>1715261728123</createTime>
  <createDate>Thu May 09 13:35:28 UTC 2024</createDate>
  <voiceBridge>66052</voiceBridge>
  <dialNumber>613-555-1234</dialNumber>
    <attendeePW>replace-with-password</attendeePW>
    <moderatorPW>replace-with-password</moderatorPW>
  <running>true</running>
  <duration>0</duration>
  <hasUserJoined>true</hasUserJoined>
  <recording>true</recording>
  <hasBeenForciblyEnded>false</hasBeenForciblyEnded>
  <startTime>1715261728142</startTime>
  <endTime>0</endTime>
  <participantCount>3</participantCount>
  <listenerCount>1</listenerCount>
  <voiceParticipantCount>2</voiceParticipantCount>
  <videoCount>2</videoCount>
  <maxUsers>0</maxUsers>
  <moderatorCount>1</moderatorCount>
  <attendees>
    <attendee>
    <userID>replace-with-user-id</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>
    <bbb-origin>greenlight</bbb-origin>
    <bbb-origin-version>v3.1.0</bbb-origin-version>
    <endcallbackurl>https://api-guide.bbbserver.com/callbacks/meeting-ended</endcallbackurl>
  </metadata>
  <isBreakout>false</isBreakout>
</response>

Відповідь з помилкою

Якщо вказаний ідентифікатор зустрічі не існує або зустріч уже завершена, API повертає відповідь FAILED:

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

getMeetingInfo проти getMeetings

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

• Логіка входу — перевіряйте, чи присутній модератор, перш ніж перенаправляти гостей до зустрічі.
• Списки учасників — відображайте поточних учасників у зовнішньому застосунку або на сторінці очікування.
• Стан запису — перевіряйте, чи активний зараз запис для зустрічі.
• Налагодження — виконуйте детальний аналіз конкретної зустрічі для усунення проблем.

Поради