getRecordings – Récupérer les enregistrements

Le point de terminaison getRecordings renvoie une liste des enregistrements de votre serveur BigBlueButton, filtrés par ID de réunion, ID d’enregistrement ou état. Il prend en charge la pagination à partir de BBB 2.7, ce qui facilite la récupération de grands ensembles d’enregistrements en segments gérables.

Point de terminaison

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

Paramètres

États des enregistrements

Champs de réponse

Exemple de requête

Tous les enregistrements publiés

getRecordings?checksum=replace-with-checksum

Enregistrements pour une réunion spécifique

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

Plusieurs réunions

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

Par ID d’enregistrement

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

Tous les états

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

Requête paginée (enregistrements 21 à 30)

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

Exemple de réponse

<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>

Pagination BBB 2.7+

Lorsque vous incluez les paramètres offset et/ou limit, la réponse contient un champ supplémentaire totalElements indiquant le nombre total d’enregistrements correspondants. Cela vous permet de calculer le nombre total de pages et de créer des contrôles de pagination dans votre application.

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

Conseils

• Utilisez recordID avec un préfixe pour rechercher des enregistrements lorsque vous ne disposez que d’un ID partiel — BigBlueButton fait correspondre tous les enregistrements dont l’ID commence par la chaîne fournie.
• Spécifiez toujours explicitement le paramètre state si vous devez voir des enregistrements encore en cours de traitement ou qui ont été supprimés, car ceux-ci sont exclus par défaut.
• Combinez meetingID avec state pour affiner efficacement les résultats — par exemple, pour trouver uniquement les enregistrements publiés d’une réunion spécifique.
• Pour les déploiements importants avec de nombreux enregistrements, utilisez la pagination afin d’éviter les délais d’attente et de réduire la taille des réponses.
• Utilisez des filtres de métadonnées (paramètres meta_) pour trouver des enregistrements en fonction d’attributs personnalisés définis lors de la création de la réunion.