← Volver al Dashboard
Mockup — Borrador / Vista Previa

API de KNineCalls

Esta API permite a sistemas externos como CRM, ERP o HIS hospitalarios consultar métricas y exportar historiales de llamadas en tiempo real.

Esta página es una previsualización de la especificación; los endpoints pueden cambiar antes de su publicación.

Autenticación

Envía tu llave en el header Authorization con el esquema Bearer:

Authorization: Bearer <tu_api_key>

Las llaves tienen el prefijo k9_live_... (producción) o k9_test_... (pruebas).

Base URL: https://api.kninecalls.com/api/v1

Endpoints

GET /api/v1/dashboard/stats

Devuelve KPIs operativos, métricas de contacto, desglose de sentimiento, llamadas que requieren atención y citas confirmadas para un rango de fechas.

Parámetros de consulta
Parámetro Tipo Requerido Descripción
start_date string Sí Fecha inicial en formato ISO YYYY-MM-DD.
end_date string Sí Fecha final en formato ISO YYYY-MM-DD.

Ejemplo

curl -H "Authorization: Bearer $KNINE_API_KEY" "https://api.kninecalls.com/api/v1/dashboard/stats?start_date=2026-01-01&end_date=2026-01-31"

Respuesta 200 OK

{
  "total_calls": 250,
  "completed_calls": 198,
  "contact_rate_percentage": 79.2,
  "average_duration_seconds": 84,
  "sentiment": { "positive": 120, "neutral": 60, "negative": 18 },
  "post_sale": { "patient_health": {}, "agents": [] },
  "attention_calls": [],
  "confirmed_appointments": 42
}

GET /api/v1/dashboard/export

Devuelve un extracto tabular en CSV para ingesta analítica o auditoría.

Parámetros de consulta
Parámetro Tipo Requerido Descripción
start_date string Sí Fecha inicial en formato ISO YYYY-MM-DD.
end_date string Sí Fecha final en formato ISO YYYY-MM-DD.

Ejemplo

curl -H "Authorization: Bearer $KNINE_API_KEY" -o export.csv "https://api.kninecalls.com/api/v1/dashboard/export?start_date=2026-01-01&end_date=2026-01-31"

Ejemplo de CSV

id,recipient_name,recipient_phone,status,duration_seconds,sentiment
call_001,Ana Pérez,+573001112233,completed,95,positive
call_002,Luis Gómez,+573004445566,failed,0,neutral

Próximamente: Gestión de API Keys

Pronto podrás gestionar tus llaves desde la consola del tenant: creación autogestionada de API keys, rotación de secretos, scopes por agente o campaña y webhooks para eventos de llamada en vivo.