Version de l’API: 4.x dernière version 3.x

Vous consultez la documentation de l’API pour BigBlueButton 3.x. La version actuelle est BigBlueButton 4.x. Vous prévoyez une mise à niveau ? Le guide de migration répertorie toutes les modifications à apporter à vos appels API.

Chapitre 8 GET POST

isMeetingRunning – Vérifier le statut de la réunion

Le point de terminaison isMeetingRunning vérifie si une réunion spécifique est actuellement active sur le serveur BigBlueButton. Il renvoie une simple valeur booléenne, ce qui en fait l'appel de surveillance le plus léger disponible dans l'API.

Point de terminaison

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum

Pour chaque requête valide, ce point de terminaison renvoie un code de retour SUCCESS, même si l’identifiant de réunion fourni n’existe pas. Dans ce cas, la valeur de running est simplement false.

Paramètres requis

Paramètre Type Obligatoire Description
meetingID String Oui L'identifiant de la réunion que vous souhaitez vérifier.

Exemple de requête

https://api-guide.bbbserver.com/bigbluebutton/api/isMeetingRunning?meetingID=replace-with-meeting-id&checksum=replace-with-checksum

Exemple de réponse

<response>
  <returncode>SUCCESS</returncode>
  <running>true</running>
</response>

Champs de réponse

Champ Type Description
returncode String SUCCESS pour chaque requête valide, que la réunion existe ou non.
running Boolean true si la réunion est actuellement en cours, false si elle n'est pas en cours ou si l'ID de réunion est inconnu.

Quand une réunion est-elle considérée comme en cours ?

Une réunion est considérée comme en cours dès qu'au moins un participant a rejoint. Une réunion fraîchement créée sans participants renverra running comme false, même si elle existe sur le serveur.

Appelez create pour configurer une nouvelle réunion sur le serveur.

À ce stade, isMeetingRunning renvoie false — personne n'a encore rejoint la réunion.

Un participant rejoint la réunion via join. La réunion est maintenant en cours.

isMeetingRunning renvoie maintenant true.

Conseils et bonnes pratiques

Bien que isMeetingRunning convienne pour une simple interrogation d'état, envisagez d'utiliser des webhooks pour une surveillance en temps réel plus efficace. Interroger ce point de terminaison à haute fréquence ajoute une charge inutile au serveur.

Ne vous appuyez pas uniquement sur isMeetingRunning pour un état détaillé de la réunion. Utilisez plutôt getMeetingInfo si vous avez besoin du nombre de participants, de l'état de l'enregistrement ou d'autres métadonnées.

  • Utilisez ce point de terminaison pour des vérifications légères de l'état de santé ou pour des tableaux de bord simples qui ont seulement besoin de savoir si une réunion est active.
  • Combinez-le avec getMeetings si vous devez surveiller plusieurs réunions à la fois — un seul appel getMeetings est plus efficace que de nombreux appels individuels isMeetingRunning.
  • Gardez un intervalle d'interrogation raisonnable (par exemple toutes les 30 à 60 secondes) afin d'éviter de mettre une charge inutile sur le serveur.

Foire aux questions

Le point de terminaison renvoie toujours SUCCESS avec running défini sur false. Il ne produit pas d'erreur pour les ID de réunion inconnus.

Non. Une réunion n'est considérée comme en cours qu'une fois qu'au moins un participant a rejoint. Une réunion qui a été créée mais qui n'a pas de participants renvoie running comme false.

Pour de simples vérifications de statut, oui. Cependant, pour une surveillance en temps réel pilotée par les événements, les webhooks constituent une alternative plus efficace, car ils envoient les mises à jour à votre application au lieu d'exiger des interrogations répétées.

isMeetingRunning renvoie uniquement un booléen indiquant si la réunion est active. getMeetingInfo renvoie des détails complets, notamment les listes de participants, l'état de l'enregistrement, les métadonnées, etc. Utilisez isMeetingRunning lorsque vous n'avez besoin que d'une réponse rapide par oui ou par non.

Oui. L'API BigBlueButton accepte les requêtes GET et POST pour isMeetingRunning. Les paramètres et la réponse sont identiques quelle que soit la méthode HTTP utilisée.