Kapitel 12 GET POST

publishRecordings – Veröffentlichen/Zurückziehen

Der Endpunkt publishRecordings schaltet die Sichtbarkeit einer oder mehrerer Aufzeichnungen um. Sie können Aufzeichnungen veröffentlichen, um sie über ihre Wiedergabe-URL zugänglich zu machen, oder die Veröffentlichung aufheben, um sie vor Betrachtern zu verbergen, während die Dateien auf dem Server erhalten bleiben.

Endpunkt

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

Sowohl die Methoden GET als auch POST werden unterstützt. Bei Verwendung von POST senden Sie die Parameter als application/x-www-form-urlencoded im Request-Body.

Parameter

Parameter Typ Beschreibung
recordID String Erforderlich. Eine durch Kommas getrennte Liste von Aufzeichnungs-IDs, die veröffentlicht oder deren Veröffentlichung aufgehoben werden sollen. Sie können in einer einzelnen Anfrage eine oder mehrere IDs angeben.
publish Boolean Erforderlich. Auf true setzen, um die Aufzeichnungen zu veröffentlichen (zugänglich zu machen), oder auf false, um die Veröffentlichung aufzuheben (vor Zuschauern zu verbergen).

Beispielanfrage

Eine einzelne Aufzeichnung veröffentlichen

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

Mehrere Aufzeichnungen unveröffentlichen

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-Anfrage mit 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"

Beispielantwort

Erfolg

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

Fehler — Aufzeichnung nicht gefunden

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

Fehlerantworten

messageKey Beschreibung
checksumError Die checksum ist ungültig. Vergewissern Sie sich, dass Sie das richtige Shared Secret verwenden und dass der checksum-Algorithmus mit der Serverkonfiguration übereinstimmt.
missingParamRecordID Der erforderliche Parameter recordID wurde nicht angegeben.
missingParamPublish Der erforderliche Parameter publish wurde nicht angegeben.
notFound Es wurde keine Aufzeichnung gefunden, die einer der angegebenen Aufzeichnungs-IDs entspricht.

Tipps

Verwenden Sie den Endpunkt getRecordings, um den aktuellen Veröffentlichungsstatus Ihrer Aufzeichnungen abzurufen, bevor Sie ihre Sichtbarkeit umschalten. Das Feld published in der Antwort zeigt an, ob jede Aufzeichnung derzeit sichtbar ist.

  • Eine veröffentlichte Aufzeichnung ist über ihre Wiedergabe-URL zugänglich. Eine unveröffentlichte Aufzeichnung bleibt auf dem Server, kann aber von Zuschauern nicht aufgerufen werden.
  • Diese Aktion ist vollständig umkehrbar — Aufzeichnungen können beliebig oft veröffentlicht und unveröffentlicht werden.
  • Sie können mehrere Aufzeichnungen stapelweise verarbeiten, indem Sie in einer einzelnen Anfrage eine durch Kommas getrennte Liste von Aufzeichnungs-IDs übergeben.
  • Wenn Sie eine Aufzeichnung dauerhaft entfernen möchten, anstatt sie nur zu verbergen, verwenden Sie den Endpunkt deleteRecordings.

Wenn Sie mehrere Aufzeichnungs-IDs übergeben und mindestens eine davon gültig ist, gibt der Aufruf SUCCESS zurück. Nur wenn keine der angegebenen IDs zu einer bestehenden Aufzeichnung passt, gibt der Server FAILED mit dem Fehler notFound zurück.

Häufig gestellte Fragen

Das Unveröffentlichen einer Aufzeichnung verbirgt sie vor Zuschauern, behält aber die Aufzeichnungsdateien auf dem Server. Sie können sie jederzeit erneut veröffentlichen. Das Löschen einer Aufzeichnung entfernt die Dateien dauerhaft vom Server und kann nicht rückgängig gemacht werden.

Ja. Übergeben Sie eine kommagetrennte Liste von Aufzeichnungs-IDs im Parameter recordID. Alle angegebenen Aufzeichnungen werden in einer einzigen Anfrage auf denselben Veröffentlichungsstatus gesetzt.

Wenn mindestens eine der angegebenen Aufzeichnungs-IDs gültig ist, gibt der Aufruf SUCCESS zurück und wendet die Änderung auf alle gültigen Aufzeichnungen an. Der Server gibt nur dann FAILED mit notFound zurück, wenn keine der IDs zu einer bestehenden Aufzeichnung passt.

Verwenden Sie den Endpunkt getRecordings und prüfen Sie das Feld published in der Antwort-XML. Es ist bei veröffentlichten Aufzeichnungen auf true und bei unveröffentlichten auf false gesetzt.

Das Unveröffentlichen einer Aufzeichnung macht ihre Wiedergabe-URL unzugänglich. Benutzer, die die Aufzeichnung gerade ansehen, können eine Unterbrechung erleben, abhängig davon, wie der Wiedergabe-Client mit der Änderung umgeht.