Saltar a contenido

API de Campañas de Llamadas — Centro de Soporte

Bienvenido al centro de documentación de la API de Neuron. Este paquete reúne todo lo que necesitas para integrar tu sistema con nuestra plataforma de campañas de llamadas con AI: desde tu primera llamada autenticada hasta consultar resultados a escala.

Elige por dónde entrar

Hay dos formas de leer esta documentación, según a qué viniste:

  • Quiero entender el flujo

    El recorrido completo de una campaña de punta a punta, en el orden real en que ocurren las cosas, con diagrama y ejemplos. Es el mejor lugar para evaluar qué hace la plataforma y cómo encaja con tu operación.

    Ciclo de vida de una campaña →

  • Quiero el contrato, ya

    Los 21 endpoints con sus parámetros, cuerpos y respuestas en una sola pantalla desplegable, y botón para ejecutar las consultas de lectura contra tu propia organización.

    Referencia interactiva →

¿Qué es esta API?

Es una API REST que te deja operar campañas de llamadas automatizadas con agentes de AI, de punta a punta:

  1. Cargas contactos mediante un archivo CSV (texto inline o subida de archivo).
  2. Lanzas una campaña asociada a un agent (cobranza, ventas/SDR, atención al cliente o entrevistas).
  3. Monitoreas el estado de la campaña en tiempo real (llamadas activas, cola pendiente).
  4. Consultas los resultados —transcripciones, sentimiento, resultado, promesas de pago— por el módulo de analytics.

Todo se autentica con una API Key vinculada a tu organización: una key solo ve los datos de tu propia organización.

Entrega de resultados por polling. Hoy los resultados se obtienen consultando los endpoints de analytics (polling con paginación por cursor). La entrega por webhooks (push hacia tu sistema) está en desarrollo — todavía no está disponible.

Mapa de navegación

Sección Para qué sirve
Ciclo de vida de una campaña Empieza aquí. El recorrido completo de punta a punta, con diagrama: autenticar, cargar la cartera, lanzar, monitorear, bajar resultados.
Referencia interactiva Todos los endpoints en una pantalla, desplegables, con ejecución de las consultas de lectura. Para quien integra.
Primeros pasos De cero a tu primera llamada autenticada en ~5 minutos.
Autenticación API Key, scopes (read / full), buenas prácticas.
Entornos Base URL canónica y la convención API_BASE_URL.
Endpoints Referencia detallada de cada endpoint (request / response).
Recetas Flujos completos paso a paso (lanzar campaña, probar sin impacto, paginar resultados).
Ejemplos Snippets de código listos para copiar.
Errores y troubleshooting Catálogo de códigos de error y cómo resolverlos.
Límites de uso (rate limits) Límites por endpoint y cómo manejar el 429.
Preguntas frecuentes (FAQ) Respuestas rápidas a las dudas más comunes.
Reglas de escalación Qué resuelve el canal de soporte automáticamente y qué requiere un humano.

Resumen de endpoints

Todos los endpoints cuelgan de la base URL canónica https://api.neuronstudio.ai.

# Método Path Propósito
1 POST /api/auth/login Login de usuario → access_token (sesión).
2 POST /api/campaign/start Iniciar campaña (CSV inline en JSON).
3 POST /api/campaign/start-upload Iniciar campaña (archivo CSV vía multipart).
4 GET /api/campaign/status Estado en tiempo real de la campaña activa.
5 POST /api/campaign/stop Detener una campaña.
6 POST /api/campaign/pause Pausar una campaña.
7 POST /api/campaign/resume Reanudar una campaña pausada.
8 POST /api/campaign/schedule Programar una campaña futura.
9 GET /api/campaign/scheduled Listar campañas programadas.
10 DELETE /api/campaign/scheduled/{campaign_id} Cancelar una campaña programada.
11 GET /api/campaigns Listar campañas (filtro ?type=).
12 GET /api/campaigns/{campaign_id}/skip-log Contactos que la plataforma descartó antes de discar, con el motivo.
13 GET /api/csv-template Descargar la plantilla CSV (filtro ?type=).
14 GET /api/analytics/stats Estadísticas agregadas.
15 GET /api/analytics/calls Llamadas paginadas (paginación por cursor).
16 GET /api/analytics/call/{call_id} Detalle de una llamada (análisis + transcripción).
17 GET /api/analytics/export Descargar los resultados en Excel (mismo archivo que el botón del panel).
18 GET /api/agents Listar los agents de tu organización (filtro ?type=).

Tipos de campaña / agent (campaign_type): collections (default), sdr, cx, interviewer.

¿Por dónde empiezo?

Si es tu primera integración, ve directo a Primeros pasos. Si ya tienes tu API Key y quieres el detalle de un endpoint, mira la carpeta Endpoints.

¿Necesitas ayuda? Revisa la FAQ y las reglas de escalación para saber qué puede resolverse al instante y qué requiere contactar a tu equipo de Neuron.