Chapitre 14 GET POST

updateRecordings – Mettre à jour les métadonnées

Le point de terminaison updateRecordings vous permet d’ajouter, de modifier ou de supprimer des métadonnées sur un ou plusieurs enregistrements existants. Cela est utile pour étiqueter des enregistrements après la fin d’une réunion — par exemple, en ajoutant un nom de présentateur, une catégorie ou un identifiant de cours — sans retraiter l’enregistrement lui-même.

Point de terminaison

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

Les méthodes GET et POST sont toutes deux prises en charge. Lors de l’utilisation de POST, envoyez les paramètres au format application/x-www-form-urlencoded dans le corps de la requête.

Paramètres requis

Paramètre Type Description
recordID String Requis. Une liste d’identifiants d’enregistrement séparés par des virgules dont les métadonnées doivent être mises à jour. Vous pouvez mettre à jour plusieurs enregistrements en un seul appel en séparant les identifiants par des virgules.

Paramètres facultatifs

Paramètre Type Description
meta_<key> String Une ou plusieurs paires clé-valeur de métadonnées. Une valeur non vide définit ou met à jour l’entrée de métadonnées. Une valeur vide supprime entièrement l’entrée de métadonnées. Le nom de la clé suit le même format que celui utilisé dans l’appel create.

Fonctionnement des mises à jour de métadonnées

Passez un ou plusieurs paramètres meta_<key> avec une valeur non vide pour définir ou mettre à jour l’entrée de métadonnées correspondante.

Passez un paramètre meta_<key> avec une valeur vide pour supprimer cette entrée de métadonnées.

Toutes les entrées de métadonnées existantes qui ne sont pas incluses dans l’appel restent inchangées.

Exemple de requête

Définir des métadonnées

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

Supprimer des métadonnées

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

Requête POST avec 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"

Exemple de réponse

Succès

<response>
  <returncode>SUCCESS</returncode>
  <updated>true</updated>
</response>

Erreur — recordID manquant

<response>
  <returncode>FAILED</returncode>
  <messageKey>missingParamRecordID</messageKey>
  <message>You must specify a recordID.</message>
</response>

Erreur — Enregistrement introuvable

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find a recording with that recordID.</message>
</response>

Réponses d’erreur

Clé du message Description
checksumError Le checksum est invalide ou ne correspond pas à la valeur attendue.
missingParamRecordID Le paramètre requis recordID n’a pas été fourni.
notFound Aucun enregistrement avec l’ID spécifié n’a été trouvé. Le serveur recherche uniquement les enregistrements published et unpublished — les enregistrements supprimés ne peuvent pas être mis à jour.

Notes bbbserver.de

bbbserver.de: Le point de terminaison updateRecordings n’est pas disponible sur bbbserver.de. Les métadonnées doivent être définies lors de l’appel create à l’aide des paramètres meta_ et ne peuvent pas être modifiées après la création de la réunion.

Conseils

Combinez updateRecordings avec le point de terminaison getRecordings pour créer une archive d’enregistrements consultable. Ajoutez des métadonnées comme le nom du présentateur, le département ou le semestre, puis utilisez le filtre meta_ dans getRecordings pour récupérer les enregistrements selon ces champs.

  • Vous pouvez mettre à jour plusieurs enregistrements à la fois en passant une liste d’ID séparés par des virgules au paramètre recordID.
  • Les entrées de métadonnées existantes qui ne sont pas mentionnées dans l’appel restent inchangées — vous n’avez pas besoin de renvoyer toutes les métadonnées à chaque fois.
  • Pour supprimer une entrée de métadonnées spécifique, passez la clé avec une valeur vide. C’est le seul moyen de supprimer des champs de métadonnées individuels.
  • Le format de clé de métadonnées est identique à celui utilisé dans l’appel create : meta_yourKeyName=yourValue.

Foire aux questions

Oui. Passez une liste d’ID d’enregistrement séparés par des virgules au paramètre recordID. Les mêmes modifications de métadonnées seront appliquées à tous les enregistrements spécifiés en un seul appel.

Elles restent inchangées. Le point de terminaison updateRecordings ne modifie que les entrées de métadonnées que vous incluez explicitement dans la requête. Toutes les autres métadonnées existantes sont conservées.

Passez la clé de métadonnée avec une valeur vide. Par exemple, meta_category= (sans valeur après le signe égal) supprimera l’entrée de métadonnée category de l’enregistrement.

Non. Le serveur recherche uniquement les enregistrements dans les états published et unpublished. Les enregistrements supprimés ne peuvent pas être trouvés ni mis à jour. Vous recevrez une erreur notFound si l’enregistrement a été supprimé.

Non. Le point de terminaison updateRecordings n’est pas implémenté sur bbbserver.de. Sur cette plateforme, les métadonnées doivent être définies lors de l’appel initial create et ne peuvent pas être modifiées par la suite.