getRecordings – Отримати записи

Кінцева точка getRecordings повертає список записів із вашого сервера BigBlueButton, відфільтрованих за ID зустрічі, ID запису або станом. Починаючи з BBB 2.7, вона підтримує пагінацію, що дозволяє легко отримувати великі набори записів керованими частинами.

Ендпоінт

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

Параметри

Стани запису

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

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

Усі опубліковані записи

getRecordings?checksum=replace-with-checksum

Записи для конкретної зустрічі

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

Кілька зустрічей

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

За ID запису

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

Усі стани

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

Запит із пагінацією (записи з 21 до 30)

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

Приклад відповіді

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

Пагінація BBB 2.7+

Якщо ви додаєте параметри offset та/або limit, відповідь міститиме додаткове поле totalElements, яке вказує загальну кількість записів, що відповідають запиту. Це дає змогу обчислити загальну кількість сторінок і побудувати елементи керування пагінацією у вашому застосунку.

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

Поради

• Використовуйте recordID із префіксом для пошуку записів, коли у вас є лише частковий ID — BigBlueButton зіставляє всі записи, ID яких починається з вказаного рядка.
• Завжди явно вказуйте параметр state, якщо вам потрібно бачити записи, які ще обробляються або були видалені, оскільки за замовчуванням вони виключаються.
• Поєднуйте meetingID із state, щоб ефективно звузити результати — наприклад, щоб знайти лише опубліковані записи для конкретної зустрічі.
• Для великих інсталяцій із великою кількістю записів використовуйте пагінацію, щоб уникнути тайм-аутів і зменшити розмір відповідей.
• Використовуйте фільтри метаданих (параметри meta_), щоб знаходити записи на основі користувацьких атрибутів, заданих під час створення зустрічі.