Cómo empezar
URL base
Todas las peticiones usan la misma URL base:
https://integrations.kleva.coAutenticación
Cada petición debe incluir tu API key en el header x-api-key.
La key identifica a tu empresa: solo puedes operar sobre tus propias campañas, contactos y agentes.
Kleva emite la API key; no es de autoservicio. Si todavía no tienes una, escribe a contact@kleva.co o solicita una conversación con el equipo. Trata la key como un secreto: guárdala en una variable de entorno o en un gestor de secretos, y no la incluyas en repositorios, frontend ni logs.
Primer request de solo lectura
Estos dos requests no realizan llamadas ni cambian nada. Úsalos para confirmar que tu key funciona y para conocer los campos que cada agente espera por contacto antes de cargar datos.
Consultar el esquema de un agente
curl "https://integrations.kleva.co/agents/schemas?agentIds=<AGENT_UUID>" \
-H "x-api-key: $KLEVA_API_KEY"
Con una key válida, la respuesta 200 trae data.schemas (un esquema JSON de entrada y de
salida por agente) y data.notFound con los UUID que no existen o no pertenecen a tu empresa. Una key
inválida responde 401. Documentación: consultar esquema de agente.
Consultar el estado de una campaña
curl "https://integrations.kleva.co/operations/campaigns/status?ids=<CAMPAIGN_UUID>" \
-H "x-api-key: $KLEVA_API_KEY"Devuelve el estado y si está en pausa para cada campaña de tu empresa. Documentación: consultar estado de campaña.
Qué puedes hacer con la API
- Agentes: consultar el esquema de entrada y salida de cada agente.
- Contactos: crear una carga de contactos, revisar sus errores y confirmarla.
- Campañas: lanzar, pausar, reanudar y cancelar campañas, cambiar su fecha de fin y consultar su estado.
- Resultados: exportar las llamadas de una campaña a CSV, exportar sus grabaciones y obtener la grabación de una llamada.
- Webhooks: recibir en tu sistema los eventos
call.endedycampaign.ended.
La API devuelve los resultados de la gestión, como las promesas de pago registradas por el agente. La API documentada no ofrece operaciones de liquidación de pagos; no la uses como procesador de pagos ni interpretes promesas como pagos confirmados. La demostración de voz del sitio es independiente de esta API.
Acciones con efecto real
Lanzar, reanudar o cargar contactos en una campaña puede iniciar llamadas reales a personas, con consumo de minutos. Cancelar una campaña es irreversible. Ejecuta estas acciones solo con autorización explícita de quien administra la cartera y verifica antes los contactos y el esquema del agente. Para explorar o probar una integración, usa los requests de solo lectura de arriba.
Referencia
- Introducción: URL base y autenticación
- Especificación OpenAPI 3.1 (JSON)
- Instrucciones para agentes de IA (Markdown)
Agentes
Campañas
Contactos
Resultados
- Crear exportación CSV
- Consultar exportación CSV
- Crear exportación de grabaciones
- Consultar exportación de grabaciones
- Obtener grabación