getRecordings – Получить записи

Эндпоинт getRecordings возвращает список записей с вашего сервера BigBlueButton, отфильтрованных по meeting ID, recording 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_), чтобы находить записи на основе пользовательских атрибутов, заданных при создании встречи.