Chapitre 12 GET POST

publishRecordings – Publier/Dépublier

Le point de terminaison publishRecordings bascule la visibilité d’un ou de plusieurs enregistrements. Vous pouvez publier des enregistrements pour les rendre accessibles via leur URL de lecture, ou les dépublier pour les masquer aux spectateurs tout en conservant les fichiers sur le serveur.

Point de terminaison

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings?<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

Paramètre Type Description
recordID String Requis. Une liste d’identifiants d’enregistrement séparés par des virgules à publier ou dépublier. Vous pouvez spécifier un ou plusieurs identifiants dans une seule requête.
publish Boolean Requis. Définissez sur true pour publier les enregistrements (les rendre accessibles), ou sur false pour les dépublier (les masquer aux spectateurs).

Exemple de requête

Publier un seul enregistrement

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

Dépublier plusieurs enregistrements

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

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

Exemple de réponse

Succès

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

Erreur — Enregistrement introuvable

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

Réponses d’erreur

messageKey Description
checksumError Le checksum est invalide. Vérifiez que vous utilisez le bon secret partagé et que l’algorithme de checksum correspond à la configuration du serveur.
missingParamRecordID Le paramètre requis recordID n’a pas été fourni.
missingParamPublish Le paramètre requis publish n’a pas été fourni.
notFound Aucun enregistrement correspondant à l’un des identifiants d’enregistrement spécifiés n’a été trouvé.

Conseils

Utilisez le point de terminaison getRecordings pour récupérer l’état de publication actuel de vos enregistrements avant de basculer leur visibilité. Le champ published dans la réponse indique si chaque enregistrement est actuellement visible.

  • Un enregistrement publié est accessible via son URL de lecture. Un enregistrement dépublié reste sur le serveur mais ne peut pas être consulté par les spectateurs.
  • Cette action est entièrement réversible — les enregistrements peuvent être publiés et dépubliés autant de fois que nécessaire.
  • Vous pouvez traiter plusieurs enregistrements par lot en transmettant une liste d’identifiants d’enregistrement séparés par des virgules dans une seule requête.
  • Si vous souhaitez supprimer définitivement un enregistrement au lieu de simplement le masquer, utilisez le point de terminaison deleteRecordings.

Lorsque vous transmettez plusieurs ID d’enregistrement et qu’au moins l’un d’entre eux est valide, l’appel renverra SUCCESS. Ce n’est que si aucun des ID fournis ne correspond à un enregistrement existant que le serveur renverra FAILED avec l’erreur notFound.

Foire aux questions

Dépublier un enregistrement le masque aux spectateurs mais conserve les fichiers d’enregistrement sur le serveur. Vous pouvez le republier à tout moment. Supprimer un enregistrement retire définitivement les fichiers du serveur et cette action est irréversible.

Oui. Passez une liste d’ID d’enregistrement séparés par des virgules dans le paramètre recordID. Tous les enregistrements spécifiés seront définis sur le même état de publication dans une seule requête.

Si au moins un des ID d’enregistrement fournis est valide, l’appel renvoie SUCCESS et applique la modification à tous les enregistrements valides. Le serveur ne renvoie FAILED avec notFound que si aucun des ID ne correspond à un enregistrement existant.

Utilisez le point de terminaison getRecordings et inspectez le champ published dans la réponse XML. Il sera défini à true pour les enregistrements publiés et à false pour les enregistrements non publiés.

Dépublier un enregistrement rend son URL de lecture inaccessible. Les utilisateurs qui consultent actuellement l’enregistrement peuvent subir une interruption selon la manière dont le client de lecture gère ce changement.