Referencia de la API

Documentación completa de la API para integrar Hanc.AI en tus aplicaciones. Gestiona agentes, consulta datos de llamadas, realiza llamadas y opera cualquier parte de la plataforma de forma programática.

---

Visión rápida

URL base	https://api.hanc.ai
Autenticación	Clave de API mediante la cabecera x-api-key
Formato	JSON

Genera una clave de API desde Integration → API Keys en el dashboard. Puedes tener hasta 3 claves por usuario; consulta la sección de claves de API en Integraciones para configuración, permisos y recomendaciones de seguridad.

curl -X GET "https://api.hanc.ai/v1/agent/list" \
  -H "x-api-key: YOUR_API_KEY"

---

Endpoints disponibles

Llamadas

Acción	Método	Endpoint
Listar llamadas	GET	/v1/call/list
Detalle de llamada (transcripción, sentimiento, resumen)	GET	/v1/call/:id
Analíticas generales (métricas por fecha/agente)	GET	/v1/call/general-metrics
Analíticas diarias	GET	/v1/call/daily-metrics
Estadísticas de sentimiento	GET	/v1/call/sentiment-stats
Desglose de costes	GET	/v1/call/costs-breakdown
Exportar llamadas (CSV)	GET	/v1/call/list/export
Exportar costes (CSV)	GET	/v1/call/costs-breakdown/export
Realizar una llamada telefónica	POST	/v1/call/make-phone-call
Realizar una llamada web	POST	/v1/call/make-web-call

Agentes

Acción	Método	Endpoint
Listar agentes	GET	/v1/agent/list
Detalle del agente	GET	/v1/agent/:id
Crear agente	POST	/v1/agent
Actualizar agente	PATCH	/v1/agent/:id
Eliminar agente	DELETE	/v1/agent/:id
Estadísticas de llamadas del agente	GET	/v1/agent/:id/call-stats
Listar plantillas de agente	GET	/v1/agent/agent_template/list

Acciones del agente:

Acción	Método	Endpoint
Listar acciones	GET	/v1/agent/:id/actions
Añadir acción	POST	/v1/agent/:id/actions
Actualizar acción	PATCH	/v1/agent/:id/actions/:actionId
Eliminar acción	DELETE	/v1/agent/:id/actions/:actionId

Herramientas del agente:

Acción	Método	Endpoint
Listar herramientas	GET	/v1/agent/:id/tools
Añadir herramienta	POST	/v1/agent/:id/tools
Actualizar herramienta	PATCH	/v1/agent/:id/tools/:toolId
Eliminar herramienta	DELETE	/v1/agent/:id/tools/:toolId

Base de conocimiento

Acción	Método	Endpoint
Listar bases de conocimiento	GET	/v1/knowledge-base/list
Crear base de conocimiento	POST	/v1/knowledge-base
Subir archivo(s)	POST	/v1/knowledge-base/:id/file(s)
Eliminar archivo	DELETE	/v1/knowledge-base/:id/file
Asignar agentes	PUT	/v1/knowledge-base/:id/agents

Números de teléfono

Acción	Método	Endpoint
Listar números	GET	/v1/phone-number/list
Números disponibles (por país)	GET	/v1/phone-number/available
Comprar un número	POST	/v1/phone-number/buy
Importar número	POST	/v1/phone-number/import
Conectar a SIP	PATCH	/v1/phone-number/connect-to-sip

Voces

Acción	Método	Endpoint
Listar voces	GET	/v1/voice/list

Filtra por idioma: GET /v1/voice/list?language=de

Suscripción

Acción	Método	Endpoint
Detalle de la suscripción	GET	/v1/subscription
Configurar recarga automática	PATCH	/v1/subscription/auto-top-up
Definir importe de recarga	PATCH	/v1/subscription/top-up-amount

Clientes

Acción	Método	Endpoint
Listar clientes	GET	/v1/customer/list
Detalle del cliente	GET	/v1/customer/:id
Crear cliente	POST	/v1/customer
Actualizar cliente	PATCH	/v1/customer/:id
Eliminar cliente	DELETE	/v1/customer/:id

Espacios de trabajo

Acción	Método	Endpoint
Operaciones de espacio de trabajo	GET/POST/PATCH/DELETE	/v1/workspaces/*
Invitar miembro	POST	/v1/workspaces/:id/invite-member
Eliminar miembro	DELETE	/v1/workspaces/:id/invite-member

---

Qué no está disponible vía API

Algunas operaciones solo están disponibles desde el dashboard:

Función	Motivo
Gestión de claves de API	Seguridad: las claves no pueden crear otras claves
Configuración de números de teléfono	Requiere configuración interactiva
Integración con Google Calendar	Requiere autorización interactiva
Facturación y pagos	Se gestiona desde el dashboard

---

¿Necesitas ayuda?

Escribe al equipo de soporte en support@hanc.ai para preguntas sobre la API.