Capítulo 14 GET POST

updateRecordings – Actualizar metadatos

El endpoint updateRecordings te permite añadir, modificar o eliminar metadatos en una o varias grabaciones existentes. Esto resulta útil para etiquetar grabaciones después de que una reunión haya terminado; por ejemplo, añadiendo el nombre de un presentador, una categoría o un identificador de curso, sin volver a procesar la grabación en sí.

Endpoint

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings?<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
recordID String Obligatorio. Una lista de ID de grabación separada por comas cuyos metadatos deben actualizarse. Puedes actualizar varias grabaciones en una sola llamada separando los ID con comas.

Parámetros opcionales

Parámetro Tipo Descripción
meta_<key> String Uno o más pares clave-valor de metadatos. Un valor no vacío establece o actualiza la entrada de metadatos. Un valor vacío elimina por completo la entrada de metadatos. El nombre de la clave sigue el mismo formato utilizado en la llamada create.

Cómo funcionan las actualizaciones de metadatos

Pasa uno o más parámetros meta_<key> con un valor no vacío para establecer o actualizar la entrada de metadatos correspondiente.

Pasa un parámetro meta_<key> con un valor vacío para eliminar esa entrada de metadatos.

Las entradas de metadatos existentes que no se incluyan en la llamada permanecen sin cambios.

Ejemplo de solicitud

Establecer metadatos

GET https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings
    ?recordID=replace-with-recording-id
  &meta_Presenter=Max+Mustermann
  &meta_category=FINANCE
    &checksum=replace-with-checksum

Eliminar metadatos

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

Solicitud POST con cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/updateRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&meta_Presenter=Max+Mustermann&meta_category=FINANCE&checksum=replace-with-checksum"

Respuesta de ejemplo

Éxito

<response>
  <returncode>SUCCESS</returncode>
  <updated>true</updated>
</response>

Error — Falta recordID

<response>
  <returncode>FAILED</returncode>
  <messageKey>missingParamRecordID</messageKey>
  <message>You must specify a recordID.</message>
</response>

Error — Grabación no encontrada

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

Respuestas de error

Clave del mensaje Descripción
checksumError El checksum es inválido o no coincide con el valor esperado.
missingParamRecordID No se proporcionó el parámetro requerido recordID.
notFound No se encontró ninguna grabación con el ID especificado. El servidor solo busca grabaciones published y unpublished; las grabaciones eliminadas no se pueden actualizar.

bbbserver.de Notas

bbbserver.de: El endpoint updateRecordings no está disponible en bbbserver.de. Los metadatos deben establecerse durante la llamada create usando parámetros meta_ y no pueden cambiarse después de que la reunión haya sido creada.

Consejos

Combina updateRecordings con el endpoint getRecordings para crear un archivo de grabaciones con capacidad de búsqueda. Añade metadatos como el nombre del presentador, departamento o semestre, y luego usa el filtro meta_ en getRecordings para recuperar grabaciones según esos campos.

  • Puedes actualizar varias grabaciones a la vez pasando una lista de IDs separada por comas al parámetro recordID.
  • Las entradas de metadatos existentes que no se mencionan en la llamada permanecen intactas — no necesitas reenviar todos los metadatos cada vez.
  • Para eliminar una entrada de metadatos específica, pasa la clave con un valor vacío. Esta es la única forma de eliminar campos individuales de metadatos.
  • El formato de la clave de metadatos es idéntico al usado en la llamada create: meta_yourKeyName=yourValue.

Preguntas frecuentes

Sí. Pasa una lista de IDs de grabación separada por comas al parámetro recordID. Los mismos cambios de metadatos se aplicarán a todas las grabaciones especificadas en una sola llamada.

Permanecen sin cambios. El endpoint updateRecordings solo modifica las entradas de metadatos que incluyes explícitamente en la solicitud. Todos los demás metadatos existentes se conservan.

Pasa la clave de metadatos con un valor vacío. Por ejemplo, meta_category= (sin ningún valor después del signo igual) eliminará la entrada de metadatos category de la grabación.

No. El servidor solo busca grabaciones en los estados published y unpublished. Las grabaciones eliminadas no se pueden encontrar ni actualizar. Recibirás un error notFound si la grabación ha sido eliminada.

No. El endpoint updateRecordings no está implementado en bbbserver.de. En esa plataforma, los metadatos deben establecerse durante la llamada inicial create y no pueden modificarse después.