Saltar al contenido principal

Obtener Grabaciones

Punto final: /recording/fetch

Este punto final le permite recuperar una lista paginada de las grabaciones disponibles. Las grabaciones se generan cuando se graba una sesión de sala y se almacenan en el servidor una vez que finaliza la sesión.

Esta API es esencial para crear una biblioteca de grabaciones orientada al usuario donde los usuarios pueden navegar, ver y administrar sus grabaciones pasadas. Puede filtrar las grabaciones por room_id o un sid de sala específico para acotar los resultados, lo que facilita la visualización de contenido relevante para sus usuarios.

Parámetros de la Solicitud

CampoTipoRequeridoDescripción
room_idsarrayUn array de IDs de sala para obtener sus grabaciones.
room_sidstringNoFiltrar grabaciones de una sesión de sala específica proporcionando su sid.
fromnumberNoÍndice inicial para los registros. El valor predeterminado es 0.
limitnumberNoNúmero máximo de registros a devolver. El valor predeterminado es 20.
order_bystringNoOrden de clasificación: DESC o ASC. El valor predeterminado es DESC.

Ejemplo de Solicitud:

{
"room_ids": ["sala01"],
"from": 0,
"limit": 20,
"order_by": "DESC"
}

Respuesta

CampoTipoPosiciónDescripción
statusbooleanraízIndica si la solicitud fue exitosa.
msgstringraízMensaje de respuesta.
status_codestringraízCódigo de estado de la respuesta.
resultobjectraízContiene los datos de las grabaciones.

Resultado

CampoTipoDescripción
total_recordingsnumberNúmero total de grabaciones encontradas.
fromnumberÍndice inicial de los registros devueltos.
limitnumberNúmero de registros devueltos.
order_bystringOrden de clasificación utilizado para los registros.
recordings_listArray<Información de la Grabación>Lista de los registros de grabaciones.

Información de la Grabación

CampoTipoDescripción
record_idstringIdentificador único de la grabación.
room_idstringID de la sala asociada a la grabación.
room_sidstringSID (Identificador de Sesión) de la sala.
file_pathstringRuta al archivo de la grabación.
file_sizenumberTamaño del archivo de la grabación en bytes.
creation_timenumberFecha y hora de creación de la grabación (marca de tiempo Unix).
room_creation_timenumberFecha y hora de creación de la sala (marca de tiempo Unix).
metadataObjeto de Metadatos de GrabaciónMetadatos asociados a la grabación.

Objeto de Metadatos de Grabación

CampoTipoDescripción
titlestringEl título de la grabación.
descriptionstringLa descripción de la grabación.
subtitlesmap Objeto de Subtítulo de GrabaciónUn mapa de códigos de idioma a objetos de subtítulos. Por ejemplo: {"en": {"url": "..."}}
extra_datamapUn mapa de datos adicionales almacenados con la grabación. Por ejemplo: {"key": "value"}

Objeto de Subtítulo de Grabación

CampoTipoDescripción
labelstringLa etiqueta para el subtítulo.
urlstringLa URL del archivo de subtítulos.