Розділ 12 GET POST

publishRecordings – Опублікувати/зняти з публікації

Кінцева точка publishRecordings перемикає видимість одного чи кількох записів. Ви можете опублікувати записи, щоб зробити їх доступними через їхню URL-адресу відтворення, або зняти з публікації, щоб приховати їх від глядачів, залишивши файли на сервері.

Ендпоінт

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

Підтримуються методи GET і POST. При використанні POST надсилайте параметри як application/x-www-form-urlencoded у тілі запиту.

Параметри

Параметр Тип Опис
recordID String Обов’язково. Список ідентифікаторів записів, розділених комами, для публікації або скасування публікації. Ви можете вказати один або кілька ідентифікаторів в одному запиті.
publish Boolean Обов’язково. Установіть значення true, щоб опублікувати записи (зробити їх доступними), або false, щоб скасувати їх публікацію (приховати їх від глядачів).

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

Опублікувати один запис

GET https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings
    ?recordID=replace-with-recording-id
  &publish=true
    &checksum=replace-with-checksum

Скасувати публікацію кількох записів

GET https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings
    ?recordID=replace-with-recording-id-1,replace-with-recording-id-2
  &publish=false
    &checksum=replace-with-checksum

Запит POST за допомогою cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&publish=true&checksum=replace-with-checksum"

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

Успіх

<response>
  <returncode>SUCCESS</returncode>
  <published>true</published>
</response>

Помилка — запис не знайдено

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find recordings.</message>
</response>

Відповіді з помилками

messageKey Опис
checksumError checksum недійсний. Переконайтеся, що ви використовуєте правильний спільний секрет і що алгоритм checksum відповідає конфігурації сервера.
missingParamRecordID Обов’язковий параметр recordID не було надано.
missingParamPublish Обов’язковий параметр publish не було надано.
notFound Не знайдено жодного запису, що відповідає будь-якому із зазначених ідентифікаторів записів.

Поради

Використовуйте ендпоінт getRecordings, щоб отримати поточний стан публікації ваших записів перед перемиканням їх видимості. Поле published у відповіді вказує, чи є кожен запис наразі видимим.

  • Опублікований запис доступний за його URL-адресою відтворення. Неопублікований запис залишається на сервері, але недоступний для глядачів.
  • Цю дію можна повністю скасувати — записи можна публікувати та скасовувати їх публікацію будь-яку кількість разів.
  • Ви можете пакетно обробляти кілька записів, передаючи список ідентифікаторів записів, розділених комами, в одному запиті.
  • Якщо ви хочете остаточно видалити запис, а не просто приховати його, використовуйте ендпоінт deleteRecordings.

Коли ви передаєте кілька ID записів і принаймні один із них є дійсним, виклик поверне SUCCESS. Лише якщо жоден із наданих ID не відповідає наявному запису, сервер поверне FAILED з помилкою notFound.

Поширені запитання

Скасування публікації запису приховує його від глядачів, але зберігає файли запису на сервері. Ви можете повторно опублікувати його будь-коли. Видалення запису назавжди прибирає файли із сервера, і це неможливо скасувати.

Так. Передайте список ID записів, розділених комами, у параметрі recordID. Усі вказані записи буде переведено в однаковий стан публікації одним запитом.

Якщо принаймні один із наданих ID записів є дійсним, виклик повертає SUCCESS і застосовує зміну до всіх дійсних записів. Сервер повертає FAILED з notFound лише якщо жоден із ID не відповідає наявному запису.

Використайте кінцеву точку getRecordings і перевірте поле published у XML-відповіді. Для опублікованих записів воно матиме значення true, а для неопублікованих — false.

Скасування публікації запису робить його URL-адресу відтворення недоступною. Користувачі, які зараз переглядають запис, можуть зіткнутися з перериванням залежно від того, як клієнт відтворення обробляє цю зміну.
Посібник з API BigBlueButton