Hoofdstuk 12 GET POST

publishRecordings – Publiceren/depubliceren

Het publishRecordings-endpoint schakelt de zichtbaarheid van één of meer opnames om. Je kunt opnames publiceren om ze toegankelijk te maken via hun afspeel-URL, of de publicatie ongedaan maken om ze voor kijkers te verbergen terwijl de bestanden op de server blijven staan.

Endpoint

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

Zowel de methoden GET als POST worden ondersteund. Bij gebruik van POST stuur je parameters als application/x-www-form-urlencoded in de requestbody.

Parameters

Parameter Type Beschrijving
recordID String Vereist. Een door komma's gescheiden lijst met opname-ID's om te publiceren of niet meer te publiceren. Je kunt een of meer ID's in één verzoek opgeven.
publish Boolean Vereist. Stel in op true om de opnames te publiceren (toegankelijk te maken), of op false om de publicatie ongedaan te maken (ze voor kijkers te verbergen).

Voorbeeldverzoek

Eén opname publiceren

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

Meerdere opnames niet meer publiceren

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-request met 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"

Voorbeeldrespons

Succes

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

Fout — Opname niet gevonden

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

Foutresponses

messageKey Beschrijving
checksumError De checksum is ongeldig. Controleer of je het juiste shared secret gebruikt en of het checksum-algoritme overeenkomt met de serverconfiguratie.
missingParamRecordID De vereiste parameter recordID is niet opgegeven.
missingParamPublish De vereiste parameter publish is niet opgegeven.
notFound Er is geen opname gevonden die overeenkomt met een van de opgegeven opname-ID's.

Tips

Gebruik de endpoint getRecordings om de huidige publicatiestatus van je opnames op te halen voordat je hun zichtbaarheid wijzigt. Het veld published in het antwoord geeft aan of elke opname momenteel zichtbaar is.

  • Een gepubliceerde opname is toegankelijk via de afspeel-URL. Een niet-gepubliceerde opname blijft op de server staan, maar is niet toegankelijk voor kijkers.
  • Deze actie is volledig omkeerbaar — opnames kunnen onbeperkt vaak worden gepubliceerd en weer niet-gepubliceerd.
  • Je kunt meerdere opnames in batch verwerken door een door komma's gescheiden lijst met opname-ID's in één verzoek door te geven.
  • Als je een opname permanent wilt verwijderen in plaats van alleen te verbergen, gebruik dan de endpoint deleteRecordings.

Wanneer je meerdere opname-ID's doorgeeft en minstens één daarvan geldig is, retourneert de call SUCCESS. Alleen als geen van de opgegeven ID's overeenkomt met een bestaande opname, retourneert de server FAILED met de fout notFound.

Veelgestelde vragen

Het niet meer publiceren van een opname verbergt deze voor kijkers, maar houdt de opnamebestanden op de server. Je kunt deze op elk moment opnieuw publiceren. Het verwijderen van een opname verwijdert de bestanden permanent van de server en kan niet ongedaan worden gemaakt.

Ja. Geef een door komma's gescheiden lijst met opname-ID's door in de parameter recordID. Alle opgegeven opnames worden in één request op dezelfde publicatiestatus gezet.

Als minstens één van de opgegeven opname-ID's geldig is, retourneert de call SUCCESS en past de wijziging toe op alle geldige opnames. De server retourneert alleen FAILED met notFound als geen van de ID's overeenkomt met een bestaande opname.

Gebruik het endpoint getRecordings en controleer het veld published in de response-XML. Dit staat op true voor gepubliceerde opnames en op false voor niet-gepubliceerde opnames.

Het niet meer publiceren van een opname maakt de afspeel-URL ontoegankelijk. Gebruikers die de opname op dat moment bekijken, kunnen een onderbreking ervaren, afhankelijk van hoe de afspeelclient met de wijziging omgaat.