Versión de la API: 4.x más reciente 3.x

Estás viendo la documentación de la API de BigBlueButton 3.x. La versión actual es BigBlueButton 4.x. ¿Planeas una actualización? La guía de migración enumera todos los cambios que necesitan tus llamadas a la API.

Capítulo 12 GET

publishRecordings – Publicar/Despublicar

El endpoint publishRecordings alterna la visibilidad de una o varias grabaciones. Puedes publicar grabaciones para hacerlas accesibles mediante su URL de reproducción, o despublicarlas para ocultarlas de los espectadores mientras se conservan los archivos en el servidor.

Endpoint

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

Este endpoint solo admite solicitudes GET. No se aceptan solicitudes POST.

Parámetros

Parámetro Tipo Descripción
recordID String Obligatorio. Una lista de IDs de grabación separada por comas para publicar o despublicar. Puedes especificar uno o más IDs en una sola solicitud.
publish Boolean Obligatorio. Establécelo en true para publicar las grabaciones (hacerlas accesibles), o en false para despublicarlas (ocultarlas de los espectadores).

Ejemplo de solicitud

Publicar una sola grabación

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

Despublicar varias grabaciones

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

Respuesta de ejemplo

Éxito

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

Error — Grabación no encontrada

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

Respuestas de error

messageKey Descripción
checksumError El checksum es inválido. Verifica que estás usando el secreto compartido correcto y que el algoritmo de checksum coincide con la configuración del servidor.
missingParamRecordID No se proporcionó el parámetro requerido recordID.
missingParamPublish No se proporcionó el parámetro requerido publish.
notFound No se encontró ninguna grabación que coincida con alguno de los IDs de grabación especificados.

Consejos

Usa el endpoint getRecordings para recuperar el estado actual de publicación de tus grabaciones antes de cambiar su visibilidad. El campo published en la respuesta indica si cada grabación es actualmente visible.

  • Una grabación publicada es accesible a través de su URL de reproducción. Una grabación no publicada permanece en el servidor.
  • Esta acción es totalmente reversible: las grabaciones pueden publicarse y despublicarse cualquier cantidad de veces.
  • Puedes procesar varias grabaciones por lotes pasando una lista de IDs de grabación separada por comas en una sola solicitud.
  • Si quieres eliminar permanentemente una grabación en lugar de simplemente ocultarla, usa el endpoint deleteRecordings.

Diferencia entre BigBlueButton y bbbserver.de
Si retiras la publicación de una grabación en la Integration-API de bbbserver, esta se muestra como unpublished en la API y los servicios externos la procesan en consecuencia. Sin embargo, la grabación en sí sigue siendo accesible si se conoce el enlace de reproducción.

Cuando pases varios IDs de grabación y al menos uno de ellos sea válido, la llamada devolverá SUCCESS. Solo si ninguno de los IDs proporcionados coincide con una grabación existente, el servidor devolverá FAILED con el error notFound.

Preguntas frecuentes

Anular la publicación de una grabación la oculta a los espectadores, pero conserva los archivos de la grabación en el servidor. Puede volver a publicarla en cualquier momento. Eliminar una grabación la pasa al estado deleted: ya no se puede reproducir ni restaurar a través de la API.

Sí. Pasa una lista de IDs de grabación separada por comas en el parámetro recordID. Todas las grabaciones especificadas se establecerán con el mismo estado de publicación en una sola solicitud.

Si al menos uno de los IDs de grabación proporcionados es válido, la llamada devuelve SUCCESS y aplica el cambio a todas las grabaciones válidas. El servidor solo devuelve FAILED con notFound si ninguno de los IDs coincide con una grabación existente.

Usa el endpoint getRecordings e inspecciona el campo published en la respuesta XML. Estará establecido en true para las grabaciones publicadas y en false para las no publicadas.