Ejemplos de integración — API de campañas de llamadas con AI¶

Esta carpeta contiene ejemplos ejecutables para integrar la API, en dos sabores:

curl/ — scripts de shell, ideales para probar rápido desde la terminal.
python/ — un cliente reutilizable y scripts para los flujos más comunes.

Todos los ejemplos apuntan a la URL base de producción y se autentican con tu API Key vía el header X-API-Key.

Prerequisitos¶

Para los ejemplos de...	Necesitas
`curl/`	`bash` y `curl`. Para formatear el JSON de respuesta, `jq` (opcional pero recomendado).
`python/`	Python 3.9+ y la librería `requests` (`pip install -r python/requirements.txt`).

Además, en ambos casos: tu API Key de la organización.

Configuración (una sola vez por sesión de terminal)¶

Los ejemplos leen dos valores del entorno:

Variable	Valor	Descripción
`API_BASE_URL`	`https://api.neuronstudio.ai`	URL base de la API. Ya viene fijada en los scripts.
`NEURON_API_KEY`	`nrn_live_...`	Tu API Key. Nunca la pongas en el código ni la subas a un repo.

Exporta tu API Key en la terminal antes de correr cualquier ejemplo:

export NEURON_API_KEY="nrn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

¿De dónde sale la API Key? No es self-serve. La emite un administrador de tu organización y se muestra una sola vez. Solicita tu API Key a tu contacto de Neuron o al administrador de tu organización.

Cómo usar los ejemplos de `curl/`¶

curl/00-setup.sh define API_BASE_URL y valida que NEURON_API_KEY esté seteada. Los demás scripts lo cargan con source automáticamente, así que solo tienes que exportar la key y correr el script que te interese:

export NEURON_API_KEY="nrn_live_..."
bash curl/list-agents.sh
bash curl/analytics-stats.sh

Cada script tiene un comentario arriba que explica qué hace y qué responde.

Cómo usar los ejemplos de `python/`¶

cd python
pip install -r requirements.txt
export NEURON_API_KEY="nrn_live_..."

python start_campaign.py contactos.csv "Cobranza Enero"
python poll_results.py
python fetch_call_detail.py call_abc123

Ver python/README.md para el detalle de cada script.

Importante antes de correr una campaña real¶

No hay modo sandbox / dry-run. Un start exitoso dispara llamadas reales de inmediato.
Para probar el flujo sin impacto: arma una lista de un solo contacto con tu propio número, corre la campaña fuera de horario productivo y valida el flujo de punta a punta con esa llamada antes de escalar a una lista completa.
Los resultados se obtienen por polling (consulta periódica), no por webhooks. Ver python/poll_results.py y curl/analytics-calls-paginate.sh.