Chapitre 5 GET POST

end – Terminer la réunion

Le point de terminaison end met immédiatement fin à une réunion BigBlueButton en cours. Tous les participants sont retirés de la conférence et, si l’enregistrement était activé, le pipeline de traitement de l’enregistrement est déclenché automatiquement.

Point de terminaison

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/end?<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 comme application/x-www-form-urlencoded dans le corps de la requête.

Paramètres requis

Paramètre Type Description
meetingID String Requis. L’ID de la réunion à terminer. Doit correspondre à l’ID utilisé lors de la création de la réunion.

Paramètres facultatifs

Paramètre Type Description
password String Deprecated Le mot de passe modérateur. Ce paramètre n’est plus requis depuis BigBlueButton 3.0 — le checksum seul suffit pour l’authentification.

Exemple de requête

Requête POST avec cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/end" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "meetingID=replace-with-meeting-id&checksum=replace-with-checksum"

Exemple de réponse

Succès

<response>
  <returncode>SUCCESS</returncode>
  <messageKey>sentEndMeetingRequest</messageKey>
  <message>A request to end the meeting was sent. Please wait a few seconds,
    and then use the getMeetingInfo or isMeetingRunning API calls to verify
    that it was ended.</message>
</response>

Erreur — Réunion introuvable

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

Notes sur bbbserver.de

bbbserver.de: Le paramètre duration dans l’appel create ne met pas automatiquement fin aux réunions sur bbbserver.de. Si vous devez terminer une réunion après un certain temps, vous devez envoyer manuellement un appel API end au moment souhaité (par exemple, via un minuteur ou cron job dans votre application).

Comportement important

L’appel end est asynchrone. La réponse confirme que la requête a été reçue, non que la réunion est entièrement terminée. Le moment exact du processus d’arrêt n’est pas officiellement spécifié.

Envoyez l’appel API end au serveur.

Attendez quelques secondes que la réunion s’arrête.

Vérifiez que la réunion est terminée en appelant getMeetingInfo ou isMeetingRunning.

Conseils

Si vous définissez le paramètre meta_endCallbackUrl pendant create, BigBlueButton enverra un callback à l’URL que vous avez spécifiée lorsque la réunion se termine. Utilisez cela pour déclencher automatiquement des workflows post-réunion.

  • Si l’enregistrement était activé, le traitement de l’enregistrement démarre automatiquement après la fin de la réunion.
  • Une réunion terminée ne peut pas être reprise — vous devez créer une nouvelle réunion.
  • Depuis BigBlueButton 3.0, le paramètre password n’est plus requis. Le checksum fournit une authentification suffisante.

Foire aux questions

Tous les participants sont immédiatement retirés de la conférence. Ils verront une notification indiquant que la réunion a été terminée par un modérateur ou un administrateur.

Non. Une fois qu’une réunion a été terminée, elle ne peut pas être reprise. Vous devez créer une nouvelle réunion à l’aide de l’appel API create. Vous pouvez réutiliser le même meetingID si vous le souhaitez.

Non. Depuis BigBlueButton 3.0, le paramètre password est obsolète et n’est plus requis. Le checksum suffit pour l’authentification. Les anciennes versions peuvent encore exiger le mot de passe modérateur.

L’appel end est asynchrone. Bien que la réponse soit généralement renvoyée en quelques millisecondes, le processus réel d’arrêt peut prendre quelques secondes. Le moment exact n’est pas officiellement spécifié. Utilisez getMeetingInfo ou isMeetingRunning pour vérifier.

Si l’enregistrement était activé pour la réunion, le pipeline de traitement de l’enregistrement est déclenché automatiquement une fois la réunion terminée. L’enregistrement sera disponible une fois le traitement terminé, ce qui peut prendre plusieurs minutes selon la durée de la réunion.