Je bekijkt de API-documentatie voor BigBlueButton 3.x. De huidige versie is BigBlueButton 4.x. Plan je een upgrade? De migratiehandleiding vermeldt alle wijzigingen die je in je API-aanroepen moet aanbrengen.
updateRecordings – Metadata bijwerken
Met het updateRecordings-endpoint kun je metadata toevoegen, wijzigen of verwijderen voor één of meer bestaande opnames. Dit is handig om opnames te labelen nadat een vergadering is geëindigd — bijvoorbeeld door een presentatornaam, een categorie of een cursus-ID toe te voegen — zonder de opname zelf opnieuw te verwerken.
Endpoint
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings?<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.
Vereiste parameters
| Parameter | Type | Beschrijving |
|---|---|---|
recordID | String | Vereist. Een door komma's gescheiden lijst met opname-ID's waarvan de metadata moet worden bijgewerkt. Je kunt meerdere opnames in één aanroep bijwerken door ID's met komma's te scheiden. |
Optionele parameters
| Parameter | Type | Beschrijving |
|---|---|---|
meta_<key> | String | Eén of meer metadata-sleutel-waardeparen. Een niet-lege waarde stelt de metadata-invoer in of werkt deze bij. Een lege waarde verwijdert de metadata-invoer volledig. De sleutelwaarde gebruikt hetzelfde formaat als in de create-call. |
Hoe metadata-updates werken
Geef een of meer meta_<key>-parameters door met een niet-lege waarde om het overeenkomstige metadata-item te plaatsen of bijwerken.
Geef een meta_<key>-parameter door met een lege waarde om dat metadata-item te verwijderen.
Bestaande metadata-items die niet in de aanroep zijn opgenomen, blijven ongewijzigd.
Voorbeeldverzoek
Metadata instellen
GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
?recordID=replace-with-recording-id
&meta_Presenter=Max+Mustermann
&meta_category=FINANCE
&checksum=replace-with-checksum Metadata verwijderen
GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
?recordID=replace-with-recording-id
&meta_category=
&checksum=replace-with-checksum POST-request met cURL
curl --request POST \
--url "https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data "recordID=replace-with-recording-id&meta_Presenter=Max+Mustermann&meta_category=FINANCE&checksum=replace-with-checksum" Voorbeeldrespons
Succes
<response>
<returncode>SUCCESS</returncode>
<updated>true</updated>
</response> Fout — Ontbrekende recordID
<response>
<returncode>FAILED</returncode>
<messageKey>missingParamRecordID</messageKey>
<message>You must specify a recordID.</message>
</response> Fout — Opname niet gevonden
<response>
<returncode>FAILED</returncode>
<messageKey>notFound</messageKey>
<message>We could not find recordings</message>
</response> Foutresponses
| Berichtsleutel | Beschrijving |
|---|---|
checksumError | De checksum is ongeldig of komt niet overeen met de verwachte waarde. |
missingParamRecordID | De vereiste parameter recordID is niet opgegeven. |
notFound | Er is geen opname gevonden met de opgegeven ID. De server zoekt alleen in published- en unpublished-opnames — verwijderde opnames kunnen niet worden bijgewerkt. |
Tips
Combineer updateRecordings met het endpoint getRecordings om een doorzoekbaar opnamearchief op te bouwen. Voeg metadata toe zoals de naam van de presentator, afdeling of semester en gebruik daarna de filter meta_ in getRecordings om opnames op basis van die velden op te halen.
- Je kunt meerdere opnames tegelijk bijwerken door een door komma's gescheiden lijst met ID's door te geven aan de parameter
recordID. - Bestaande metadata-items die niet in de aanroep worden genoemd, blijven ongewijzigd — je hoeft niet telkens alle metadata opnieuw mee te sturen.
- Om een specifiek metadata-item te verwijderen, geef je de sleutel door met een lege waarde. Dit is de enige manier om afzonderlijke metadatavelden te verwijderen.
- De indeling van de metadata-sleutel is identiek aan die in de
create-aanroep:meta_yourKeyName=yourValue.
Veelgestelde vragen
recordID. Dezelfde metadatawijzigingen worden in één call toegepast op alle opgegeven opnames.updateRecordings-endpoint wijzigt alleen de metadata-items die je expliciet in de request opneemt. Alle andere bestaande metadata blijven behouden.meta_category= (zonder waarde na het gelijkteken) verwijdert het metadata-item category uit de opname.published en unpublished. Verwijderde opnames kunnen niet worden gevonden of bijgewerkt. Je ontvangt een notFound-fout als de opname is verwijderd.