getRecordings – Aufzeichnungen abrufen

Der Endpunkt getRecordings gibt eine Liste von Aufzeichnungen Ihres BigBlueButton-Servers zurück, gefiltert nach Meeting-ID, Aufzeichnungs-ID oder Status. Seit BBB 2.7 unterstützt er Paginierung, wodurch große Mengen von Aufzeichnungen in handhabbaren Blöcken abgerufen werden können.

Endpunkt

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

Parameter

Aufzeichnungsstatus

Antwortfelder

Beispielanfrage

Alle veröffentlichten Aufzeichnungen

getRecordings?checksum=replace-with-checksum

Aufzeichnungen für ein bestimmtes Meeting

getRecordings?meetingID=replace-with-meeting-id&checksum=replace-with-checksum

Mehrere Meetings

getRecordings?meetingID=replace-with-meeting-id-1,replace-with-meeting-id-2&checksum=replace-with-checksum

Nach Aufzeichnungs-ID

getRecordings?recordID=replace-with-recording-id&checksum=replace-with-checksum

Alle Status

getRecordings?state=any&checksum=replace-with-checksum

Paginierte Anfrage (Aufzeichnungen 21 bis 30)

getRecordings?state=published&offset=20&limit=10&checksum=replace-with-checksum

Beispielantwort

<response>
  <returncode>SUCCESS</returncode>
  <recordings>
    <recording>
    <recordID>replace-with-recording-id</recordID>
    <meetingID>replace-with-meeting-id</meetingID>
    <internalMeetingID>replace-with-internal-meeting-id</internalMeetingID>
      <name>Project Meeting</name>
      <isBreakout>false</isBreakout>
      <published>true</published>
      <state>published</state>
      <startTime>1462283509434</startTime>
      <endTime>1462284509434</endTime>
      <participants>5</participants>
      <metadata>
        <bbb-origin>greenlight</bbb-origin>
      </metadata>
      <rawSize>123456789</rawSize>
      <size>98765432</size>
      <playback>
        <format>
          <type>presentation</type>
                    <url>https://api-guide.bbbserver.com/playback/presentation/2.3/replace-with-recording-id</url>
          <processingTime>62890</processingTime>
          <length>45</length>
          <size>98765432</size>
          <preview>
            <images>
              <image width="176" height="136" alt="Welcome">
                                https://api-guide.bbbserver.com/presentation/replace-with-recording-id/thumbnail_0.png
              </image>
            </images>
          </preview>
        </format>
      </playback>
    </recording>
  </recordings>
</response>

Paginierung BBB 2.7+

Wenn du die Parameter offset und/oder limit einschließt, enthält die Antwort ein zusätzliches Feld totalElements, das die Gesamtzahl der übereinstimmenden Aufzeichnungen angibt. So kannst du die Gesamtzahl der Seiten berechnen und Paginierungs-Steuerelemente in deiner Anwendung erstellen.

<response>
  <returncode>SUCCESS</returncode>
  <totalElements>42</totalElements>
  <recordings>
    <!-- recording elements -->
  </recordings>
</response>

Tipps

• Verwenden Sie recordID mit einem Präfix, um nach Aufzeichnungen zu suchen, wenn Sie nur eine partielle ID haben — BigBlueButton findet alle Aufzeichnungen, deren ID mit der angegebenen Zeichenfolge beginnt.
• Gib den Parameter state immer explizit an, wenn du Aufzeichnungen sehen musst, die noch verarbeitet werden oder gelöscht wurden, da diese standardmäßig ausgeschlossen sind.
• Kombiniere meetingID mit state, um die Ergebnisse effizient einzugrenzen — zum Beispiel, um nur veröffentlichte Aufzeichnungen für ein bestimmtes Meeting zu finden.
• Bei großen Installationen mit vielen Aufzeichnungen solltest du Paginierung verwenden, um Timeouts zu vermeiden und die Antwortgrößen zu reduzieren.
• Verwende Metadaten-Filter (Parameter meta_), um Aufzeichnungen anhand benutzerdefinierter Attribute zu finden, die bei der Erstellung des Meetings gesetzt wurden.