Saltar al contenido principal

Obtener Artefactos

Endpoint: /artifact/fetch

Este endpoint le permite recuperar una lista paginada de todos los artefactos de reunión generados. Puede filtrar los resultados por sala, sesión o tipo de artefacto.

Parámetros de la Solicitud

CampoTipoRequeridoDescripción
room_idsarray de stringsNoUn array de uno o más room_ids para filtrar los resultados.
room_sidstringNoFiltrar artefactos de una sesión de sala específica proporcionando su sid.
typestring o numberNoFiltrar por un tipo de artefacto específico. Puede usar el nombre en cadena (p. ej., MEETING_ANALYTICS) o su valor entero correspondiente. Vea los Tipos de Artefactos a continuación.
fromnumberNoEl desplazamiento inicial para la paginación. Por defecto: 0.
limitnumberNoEl número máximo de artefactos a devolver. Por defecto: 20, Máximo: 100.
order_bystringNoEl orden de clasificación para los resultados. Puede ser ASC o DESC. Por defecto: DESC.

Ejemplo de Solicitud

{
"room_ids": ["sala01", "sala02"],
"type": "MEETING_ANALYTICS",
"limit": 10
}

Respuesta

CampoTipoDescripción
statusbooleanIndica si la solicitud fue exitosa.
msgstringMensaje de respuesta.
status_codestringCódigo de estado de la respuesta.
resultResultadoEl objeto que contiene la lista de artefactos.

Resultado

CampoTipoDescripción
total_artifactsnumberEl número total de artefactos que coinciden con la consulta.
fromnumberEl desplazamiento de paginación del conjunto de resultados actual.
limitnumberEl límite de paginación del conjunto de resultados actual.
order_bystringEl orden de clasificación del conjunto de resultados.
typestringEl tipo de artefacto por el que se filtró.
artifacts_listarray de ArtifactInfoLa lista de objetos de artefactos. Consulte la página Obtener Información del Artefacto para la estructura detallada del objeto ArtifactInfo.

Tipos de Artefactos

El campo type identifica el tipo de artefacto. Puede usar el nombre en cadena (p. ej., MEETING_ANALYTICS) o su valor entero correspondiente al filtrar.

Algunos ejemplos comunes incluyen:

  • MEETING_SUMMARY
  • SPEECH_TRANSCRIPTION
  • MEETING_ANALYTICS
  • MEETING_SUMMARY_USAGE

Para obtener una lista completa y actualizada de todos los tipos de artefactos disponibles, consulte el archivo oficial plugnmeet_room_artifacts.proto.