Capítulo 5 GET POST

end – Finalizar reunión

El endpoint end finaliza inmediatamente una reunión BigBlueButton en ejecución. Todos los participantes son eliminados de la conferencia y, si la grabación estaba habilitada, la canalización de procesamiento de grabación se activa automáticamente.

Endpoint

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

Se admiten los métodos GET y POST. Al usar POST, envía los parámetros como application/x-www-form-urlencoded en el cuerpo de la solicitud.

Parámetros obligatorios

Parámetro Tipo Descripción
meetingID String Obligatorio. El ID de la reunión que se va a finalizar. Debe coincidir con el ID usado cuando se creó la reunión.

Parámetros opcionales

Parámetro Tipo Descripción
password String Deprecated La contraseña del moderador. Este parámetro ya no es obligatorio desde BigBlueButton 3.0; checksum por sí solo es suficiente para la autenticación.

Ejemplo de solicitud

Solicitud POST con 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"

Respuesta de ejemplo

Éxito

<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>

Error — Reunión no encontrada

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

Notas de bbbserver.de

bbbserver.de: El parámetro duration en la llamada create no finaliza automáticamente las reuniones en bbbserver.de. Si necesitas finalizar una reunión después de un tiempo determinado, debes enviar manualmente una llamada API end en el momento deseado (por ejemplo, mediante un temporizador o cron job en tu aplicación).

Comportamiento importante

La llamada end es asíncrona. La respuesta confirma que la solicitud fue recibida, no que la reunión haya finalizado por completo. El momento exacto del proceso de cierre no está especificado oficialmente.

Envía la llamada API end al servidor.

Espera unos segundos a que la reunión se cierre.

Verifica que la reunión haya finalizado llamando a getMeetingInfo o isMeetingRunning.

Consejos

Si estableces el parámetro meta_endCallbackUrl durante create, BigBlueButton enviará una devolución de llamada a la URL especificada cuando finalice la reunión. Úsalo para activar automáticamente flujos de trabajo posteriores a la reunión.

  • Si la grabación estaba habilitada, el procesamiento de la grabación comienza automáticamente después de que termine la reunión.
  • Una reunión que ha sido finalizada no puede reanudarse — debes crear una nueva reunión.
  • Desde BigBlueButton 3.0, el parámetro password ya no es obligatorio. checksum proporciona autenticación suficiente.

Preguntas frecuentes

Todos los participantes son eliminados inmediatamente de la conferencia. Verán una notificación de que la reunión ha sido finalizada por un moderador o administrador.

No. Una vez que una reunión ha finalizado, no puede reanudarse. Debes crear una nueva reunión usando la llamada API create. Si lo deseas, puedes reutilizar el mismo meetingID.

No. Desde BigBlueButton 3.0, el parámetro password está obsoleto y ya no es obligatorio. checksum es suficiente para la autenticación. Las versiones anteriores aún pueden requerir la contraseña del moderador.

La llamada end es asíncrona. Aunque la respuesta suele devolverse en milisegundos, el proceso real de cierre puede tardar unos segundos. El tiempo exacto no está especificado oficialmente. Usa getMeetingInfo o isMeetingRunning para verificarlo.

Si la grabación estaba habilitada para la reunión, el proceso de procesamiento de la grabación se activa automáticamente una vez que la reunión termina. La grabación estará disponible cuando se complete el procesamiento, lo que puede tardar varios minutos según la duración de la reunión.