Capítulo 13 GET POST

deleteRecordings – Eliminar grabaciones

El endpoint deleteRecordings elimina permanentemente una o más grabaciones de su servidor BigBlueButton. Puede pasar un único ID de grabación o una lista separada por comas para eliminar varias grabaciones en una sola solicitud.

Esta llamada a la API surte efecto inmediatamente sin ningún aviso de confirmación. Asegúrese de tener los IDs de grabación correctos antes de enviar la solicitud. Las grabaciones eliminadas no pueden restaurarse a través de la API.

Endpoint

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

Parámetros

Parámetro Tipo Obligatorio Predeterminado Descripción
recordID String Sí — Un único ID de grabación o una lista separada por comas de IDs de grabación para eliminar.

Ejemplo de solicitud

Eliminar una única grabación: 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id&checksum=replace-with-checksum

Eliminar varias grabaciones en una sola llamada: 

https://api-guide.bbbserver.com/bigbluebutton/api/deleteRecordings?recordID=replace-with-recording-id-1,replace-with-recording-id-2&checksum=replace-with-checksum

Respuesta de ejemplo

Una llamada correcta devuelve el siguiente XML: 

<response>
  <returncode>SUCCESS</returncode>
  <deleted>true</deleted>
</response>

Respuestas de error

messageKey Descripción
checksumError El checksum no es válido.
missingParamRecordID No se proporcionó el parámetro recordID.
notFound No se encontró en el servidor ninguna grabación con el ID especificado.

Las grabaciones no se eliminan físicamente del disco de inmediato. El servidor mueve los archivos a un directorio deleted/. Un administrador del servidor puede recuperar potencialmente las grabaciones eliminadas de este directorio antes de que se purguen de forma permanente.

Comportamiento después de la eliminación

  • El estado de la grabación cambia a deleted.
  • Las grabaciones eliminadas ya no aparecen en las respuestas estándar de getRecordings.
  • Para recuperar grabaciones eliminadas a través de la API, pase state=deleted o state=any como parámetro state en una llamada a getRecordings.
En bbbserver.de, puede llamar a este endpoint usando sus credenciales de API que se encuentran en el panel de administración del servidor. Asegúrese de que los IDs de grabación coincidan con grabaciones que pertenezcan a su instancia del servidor.

Buenas prácticas

Verifique siempre los IDs de grabación con una llamada a getRecordings antes de eliminar para evitar borrar las grabaciones equivocadas.

Implemente un paso de confirmación en su aplicación antes de llamar a este endpoint, ya que la propia API no requiere confirmación.

Registre cada solicitud de eliminación, incluidos los IDs de grabación y las marcas de tiempo, para poder rastrear qué grabaciones se eliminaron y cuándo.

Al eliminar varias grabaciones, agrúpelas en una única solicitud separada por comas en lugar de hacer llamadas individuales a la API para cada grabación.

Preguntas frecuentes

No inmediatamente. El servidor mueve los archivos de grabación a un directorio deleted dedicado. Un administrador del servidor puede recuperarlos desde allí hasta que los archivos sean eliminados definitivamente por un proceso de limpieza. Sin embargo, no existe ningún endpoint de API para restaurar grabaciones eliminadas.

Sí. Pase una lista separada por comas de IDs de grabación en el parámetro recordID. Todas las grabaciones especificadas se eliminarán en una sola llamada.

La API puede devolver un error notFound si no se puede hacer coincidir ninguno de los IDs de grabación especificados. Al mezclar IDs válidos e inválidos, el comportamiento puede variar según la versión de BigBlueButton. Se recomienda verificar todos los IDs antes de enviar la solicitud.

Sí, pero solo si las solicita explícitamente estableciendo el parámetro state en deleted o any en su llamada a getRecordings. De forma predeterminada, las grabaciones eliminadas se ocultan de los resultados.

No. La API de BigBlueButton no proporciona un endpoint para restaurar grabaciones eliminadas. La recuperación solo es posible a nivel del sistema de archivos del servidor por parte de un administrador del sistema.