Obtener Artefactos
Punto final: /artifact/fetch
Este punto final 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 Solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| room_ids | array de cadenas | No | Un array de uno o más room_ids para filtrar los resultados. |
| room_sid | string | No | Filtrar artefactos de una sesión de sala específica proporcionando su sid. |
| type | cadena o número | No | Filtrar por un tipo de artefacto específico. Puede usar el nombre de la cadena (p. ej., MEETING_ANALYTICS) o su valor entero correspondiente. Vea los Tipos de Artefactos a continuación. |
| from | number | No | El desplazamiento inicial para la paginación. Predeterminado: 0. |
| limit | number | No | El número máximo de artefactos a devolver. Predeterminado: 20, Máximo: 100. |
| order_by | string | No | El orden de clasificación para los resultados. Puede ser ASC o DESC. Predeterminado: DESC. |
Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| status | boolean | Indica si la solicitud fue exitosa. |
| msg | string | Mensaje de respuesta. |
| result | Resultado | El objeto que contiene la lista de artefactos. |
Resultado
| Campo | Tipo | Descripción |
|---|---|---|
| total_artifacts | number | El número total de artefactos que coinciden con la consulta. |
| from | number | El desplazamiento de paginación del conjunto de resultados actual. |
| limit | number | El límite de paginación del conjunto de resultados actual. |
| order_by | string | El orden de clasificación del conjunto de resultados. |
| type | string | El tipo de artefacto por el que se filtró. |
| artifacts_list | array de ArtifactInfo | La lista de objetos de artefacto. 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 de la cadena (p. ej., MEETING_ANALYTICS) o su valor entero correspondiente al filtrar.
Algunos ejemplos comunes incluyen:
MEETING_SUMMARYSPEECH_TRANSCRIPTIONMEETING_ANALYTICSMEETING_SUMMARY_USAGE
Para obtener una lista completa y actualizada de todos los tipos de artefactos disponibles, consulte el archivo oficial plugnmeet_room_artifacts.proto.