Cómo funciona la autenticación

Las API utilizan credenciales del portal (email + portalApiKey) y headers dedicados en cada llamada de negocio. Un segundo nivel de clave (assistantApiKey) protege las operaciones sobre cada asistente.

🔑

Login del portal

Llama a POST /api/v1/auth/portal/login pasando email y portalApiKey para validar las credenciales del cliente.

📨

Headers de sesión

En cada solicitud de negocio envía los headers x-client-email y x-portal-api-key. Todo el tráfico viaja por HTTPS/TLS.

🤖

Operaciones por asistente

Para modificar un asistente usa su assistantApiKey en el path: /api/v1/assistants/{assistantApiKey}/...

Áreas funcionales expuestas por las API

Las API exponen toda la plataforma AI4CALL. Cada área se corresponde con un grupo de tags Swagger y se gobierna de forma programática con la misma lógica que el portal gráfico.

⚙️

Cuenta y entorno

Gestiona la configuración global del cliente: IPs autorizadas, límites de llamada, enrutamiento de números y plugins activos.

  • /account/allowed-ips — Whitelist de IP (lectura/actualización)
  • /account/call-limits — Límites de llamadas concurrentes y por periodo
  • /account/number-routing — Mapeo número → asistente
  • /account/plugins/* — Plugins disponibles, instancias, configuraciones y compra
🤖

Asistentes y prompt

CRUD completo sobre los asistentes IA: creación, lectura, actualización de prompt, primer mensaje y ajustes.

  • GET/POST /assistants — Listado y creación de asistentes
  • /assistants/{key} — Detalle de un único asistente
  • /assistants/{key}/prompt — Prompt + first message editables
  • /runtime/settings — Settings runtime y advanced settings
🎙️

Voz: TTS, ASR, LLM, DTMF

Elige proveedor y modelos de TTS, ASR, LLM y DTMF, y aplícalos al asistente al instante.

  • /catalog/providers/tts + tts/voices
  • /catalog/providers/asr + asr/models
  • /catalog/providers/llm + llm/models
  • /runtime/{tts|asr|llm|dtmf} — Actualización runtime de TTS, ASR, LLM y DTMF
📚

RAG y base de conocimiento

Sube documentos, gestiona colecciones y vincula bases de conocimiento a los asistentes para respuestas siempre actualizadas.

  • /catalog/rag/collections — Listado de colecciones RAG
  • /rag/collections/{name}/documents — Subida, listado y eliminación de documentos
  • /rag/documents/estimate — Estimación previa de indexación
  • /runtime/rag — Binding de RAG runtime sobre el asistente
🔌

Herramientas y Pre-Call

Amplía los asistentes con herramientas del catálogo y lógica pre-call: validación de número, configuración MCP y herramientas runtime.

  • /catalog/tools — Catálogo de herramientas runtime del cliente
  • /runtime/tools — Herramientas vinculadas a un asistente
  • /runtime/precall/number-validation
  • /runtime/precall/mcp-config
📴

Hangup y post-llamada

Define el comportamiento al final de la llamada: redirección, transferencia, guardado de conversación y esquema de datos estructurado.

  • /runtime/hangup — Configuración de hangup, redirección y transferencia
  • /runtime/hangup/save-conversation
  • /runtime/hangup/schema
  • Catálogo de opciones de hangup disponibles
📞

Outbound y PBX

Lanza llamadas salientes desde tu backend, ya sea con el trunk AI4CALL o con el PBX del cliente, mediante webhooks sencillos.

  • POST /webhook/outbound_call — Saliente vía trunk AI4CALL
  • POST /webhook/outbound_call_pbx — Saliente vía PBX del cliente
  • Metadatos personalizados (lead_id, ticket…)
  • Seguimiento del resultado en Analytics
📊

Analítica e historial

Expón el historial de llamadas, recargas, RAG, SMS y tool responses para tus informes y paneles.

  • /account/analytics/calls + calls-outbound
  • /account/analytics/recharges
  • /account/analytics/rag · sms · tool-responses
  • /account/analytics/pre-call

Empieza en 4 pasos

De la activación a la primera llamada vía API en pocos minutos.

Activa una cuenta

Registra tu empresa en AI4CALL y elige el plan más adecuado a tu caso de uso.

🔐

Genera la portalApiKey

Desde el portal crea una clave dedicada para cada aplicación o entorno (test, producción).

🧭

Explora Swagger

Abre la documentación interactiva, prueba los endpoints y copia las solicitudes ya listas.

🚀

Integra y pasa a producción

Conecta las API a tus sistemas, configura outbound y analítica y monitoriza el consumo.

Ejemplos cURL

Tres snippets que cubren el flujo más común: login, listado de asistentes, lanzamiento de outbound.

1. Login del portal

curl -X POST https://client-api.ai4call.com/api/v1/auth/portal/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "demo@ai4call.local",
    "portalApiKey": "portal_demo_key_123456789"
  }'

2. Listar los asistentes del cliente

curl -X GET https://client-api.ai4call.com/api/v1/assistants \
  -H "x-client-email: demo@ai4call.local" \
  -H "x-portal-api-key: portal_demo_key_123456789"

3. Lanzar una llamada saliente

curl -X POST https://client-api.ai4call.com/webhook/outbound_call \
  -H "x-client-email: demo@ai4call.local" \
  -H "x-portal-api-key: portal_demo_key_123456789" \
  -H "Content-Type: application/json" \
  -d '{
    "assistantApiKey": "ast_xxx",
    "to": "+39081...",
    "from": "+3902...",
    "metadata": { "lead_id": "123" }
  }'

Todos los endpoints están documentados en Swagger con request/response de ejemplo, códigos de error y esquemas JSON. Los headers x-client-email y x-portal-api-key son obligatorios en cada llamada de negocio.

Escenarios de integración

Las API de AI4CALL se adaptan tanto a software de gestión como a flujos automatizados low-code.

🏢

Integración CRM / ERP

Sincroniza leads, tickets y actividades con tu software y lanza llamadas IA directamente desde el CRM.

⚙️

Automatizaciones internas

Orquesta campañas salientes, confirmaciones de cita, recordatorios y encuestas automáticas mediante webhook.

📈

Informes avanzados

Lleva los datos de AI4CALL a tu data warehouse o herramientas BI (Power BI, Looker, Metabase).

🔄

Workflows no-code

Conecta AI4CALL con herramientas como n8n, Zapier o Make para automatizar flujos sin escribir código.

🛠️

Herramientas y plugins personalizados

Expón tus funciones de negocio como herramientas que los asistentes pueden invocar durante las llamadas.

📦

Multi-tenant y revendedores

Construye portales y paneles multi-cliente sobre las API, con aislamiento de datos y branding.

Seguridad, fiabilidad y cumplimiento

Las API están diseñadas para entornos de producción: seguras, monitorizadas y versionadas.

🔐

Autenticación de doble nivel

Headers x-client-email + x-portal-api-key para el cliente, assistantApiKey en el path para operaciones por asistente. Todo sobre HTTPS/TLS.

🌍

Whitelist de IP

Limita el uso de las API a una lista de IPs autorizadas, gestionada vía /account/allowed-ips.

⏱️

Límites y cuotas

Endpoint dedicado /account/call-limits para leer y actualizar límites de llamada sin superar la capacidad contractual.

📜

Versionado estable

Todos los endpoints de negocio están bajo /api/v1/. Los cambios incompatibles se publicarán en una nueva versión major.

Documentación Swagger interactiva

Explora cada endpoint, prueba las solicitudes en vivo, descarga la especificación openapi.yaml y genera clientes en tu lenguaje favorito.

Ir a swagger.ai4call.com

La API está documentada según el estándar OpenAPI 3.0.3 y se puede explorar mediante Swagger UI en https://swagger.ai4call.com/. El fichero openapi.yaml se descarga desde la misma página.

La URL base de producción es https://client-api.ai4call.com. Todos los endpoints de negocio están bajo /api/v1/, mientras que los outbound usan el prefijo /webhook/.

Se empieza con POST /api/v1/auth/portal/login pasando email y portalApiKey. Después, cada solicitud de negocio debe incluir los headers x-client-email y x-portal-api-key. Las operaciones sobre un asistente requieren además la assistantApiKey en el path.

Sí. GET/POST /api/v1/assistants permite listar y crear, GET /api/v1/assistants/{assistantApiKey} el detalle. El tag Assistants en Swagger agrupa todas las operaciones disponibles.

Sí, mediante GET y PATCH en /api/v1/assistants/{assistantApiKey}/prompt. Está pensado para edición programática de prompt y first message sin pasar por el portal.

Para cada proveedor/voz/modelo disponible hay un endpoint de catálogo (p. ej. /api/v1/catalog/providers/tts, /catalog/assistants/{key}/asr/models) y un endpoint runtime de asignación (PATCH /api/v1/assistants/{assistantApiKey}/runtime/{tts|asr|llm|dtmf}).

Las colecciones RAG están bajo /api/v1/catalog/rag/: listado, subida y eliminación de documentos, estimación previa de indexación y binding sobre el asistente con PATCH /assistants/{key}/runtime/rag.

Sí. GET /api/v1/catalog/tools devuelve las herramientas disponibles, mientras que /catalog/assistants/{key}/tools y PATCH /assistants/{key}/runtime/tools permiten asignarlas a un asistente.

Bajo /api/v1/assistants/{key}/runtime/precall/ puedes configurar la number-validation y la mcp-config. /catalog/assistants/{key}/pre-call expone las opciones disponibles.

Endpoint PATCH /assistants/{key}/runtime/hangup para redirección/transferencia, /runtime/hangup/save-conversation para guardar la conversación y /runtime/hangup/schema para definir un esquema de datos estructurado.

Mediante POST /webhook/outbound_call (trunk AI4CALL) o POST /webhook/outbound_call_pbx (PBX del cliente). En ambos casos indicas el asistente, el número a llamar y los metadatos personalizados.

Bajo /api/v1/account/analytics/ encuentras historial de llamadas entrantes y salientes, recargas, eventos RAG, SMS, tool responses y pre-call. Pensadas para integrarse en BI o data warehouse.

Sí. GET/PATCH /api/v1/account/allowed-ips permite leer y actualizar la whitelist de IPs autorizadas a autenticarse y usar las API.

Con GET/PATCH /api/v1/account/call-limits puedes leer y actualizar los límites, por ejemplo llamadas concurrentes o por periodo, según el plan contratado.

Sí. Puedes listar los plugins disponibles (/account/plugins/available), gestionar las instancias (/account/plugins/instances), actualizar la configuración (/account/plugins/configuration) y finalizar la compra (PATCH /account/plugins/purchase).

Sí, GET /health devuelve el estado del servicio. No requiere autenticación y es útil para monitorización y sondas automáticas.

Todos los endpoints de negocio están bajo el prefijo /api/v1/. Los cambios no retrocompatibles se publicarán como /api/v2/, manteniendo v1 activa durante el periodo de transición.

Puedes usar credenciales (email + portalApiKey) dedicadas a entornos de prueba, aislando configuraciones y números de las llamadas de producción. Contáctanos desde el portal para activar una cuenta de test.

Tecnología y personas:
juntos, cero esperas y mil soluciones.

¿Listo para transformar
tus llamadas?

Solicita una demo gratuita y descubre cómo AI4CALL puede revolucionar tu negocio


Algunos de los usuarios de ai4call