Llamadas Documentación del endpoint de Llamadas

Consultar Todas las Llamadas

Este endpoint permite obtener un listado de todas las llamadas registradas en el sistema.

Método HTTP

GET

Endpoint URL

GET {{base_url}}/xia_calls

Nota: Ajusta {{base_url}} según la URL base de tu API.

Parámetros de Consulta (Opcionales)

  • limit (integer): Número máximo de llamadas a devolver por página.
  • page (integer): Número de página para la paginación.
  • assistantId (string/uuid): Filtra las llamadas por el ID de un asistente específico.
  • status (string): Filtra las llamadas por estado (ej. "ended", "in-progress").
  • startDate (timestamp/date): Filtra llamadas iniciadas después de esta fecha.
  • endDate (timestamp/date): Filtra llamadas iniciadas antes de esta fecha.

Formato de Respuesta Exitosa (JSON)

Si la solicitud es exitosa, se obtiene un objeto JSON con la siguiente estructura:


                {
                    "status": "Ok",
                    "data": [
                        {
                            "id": "59fd3f8f-b4b4-48dc-95b0-9c2d8ff065b3",
                            "assistantId": "92fd525f-cc3c-4407-a04d-9108d3f31545",
                            "type": "outboundPhoneCall",
                            "status": "ended",
                            "startedAt": "2025-05-22T10:02:54.658Z",
                            "endedAt": "2025-05-22T10:03:02.531Z",
                            "customer": {
                                "number": "+34638580407"
                            },
                            "createdAt": "2025-05-22T10:02:49.497Z"
                        },
                        {
                            "id": "another-call-uuid-12345",
                            "assistantId": "92fd525f-cc3c-4407-a04d-9108d3f31545",
                            "type": "inboundPhoneCall",
                            "status": "in-progress",
                            "startedAt": "2025-05-23T11:00:00.000Z",
                            "endedAt": null,
                            "customer": {
                                "number": "+34555678901"
                            },
                            "createdAt": "2025-05-23T10:59:55.000Z"
                        }
                        // ... más objetos de llamadas
                    ],
                    "status_code": 200
                }
                

Campos clave en cada objeto de `data` (listado):

  • id: (UUID/string) Identificador único de la llamada.
  • assistantId: (UUID/string) ID del asistente que manejó la llamada.
  • type: (string) Tipo de llamada (ej. "outboundPhoneCall", "inboundPhoneCall").
  • status: (string) Estado actual de la llamada (ej. "ended", "in-progress", "failed").
  • startedAt: (timestamp) Fecha y hora de inicio de la llamada.
  • endedAt: (timestamp/null) Fecha y hora de finalización de la llamada (null si está en progreso).
  • customer: (object) Información del cliente.
    • number: (string) Número de teléfono del cliente.
  • createdAt: (timestamp) Fecha y hora de creación del registro de la llamada.
  • (Otros campos): Para ver la lista completa de campos de una llamada, consulta la documentación de "GET Llamada Específica". Esta vista de listado puede devolver un subconjunto de los campos.

Posibles Errores

  • 401 Unauthorized: Token de autenticación no válido o ausente.
  • 422 Unprocessable Entity: Si los parámetros de filtrado no son válidos.
  • 500 Internal Server Error: Error inesperado en el servidor.