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

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

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

Советы