Nexo Tecnología VoIP
API (Application Programming Interface)
Interfases API
Introducción - Funciones
En términos generales, las interfases (API, AMI, etc.) permiten la interconexión de la Plataforma VoIP con otros sistemas, de otros fabricantes, que proveen funciones o servicios adicionales que realizan operaciones complementarias a las que habitualmente pueden encontrarse en un sistema de telefonía IP.
Los proveedores de estos sistemas o servicios que dan apoyo a la Plataforma VoIP ofrecen Sistemas de Soporte a las Operaciones (OSS) y Sistemas de Soporte al Negocio (BSS), con funciones que son parte de la gestión administrativa de la empresa, del negocio, de la institución o de la organización.
Estos sistemas de soporte, a la gestión del negocio (BSS), están representados, entre otros, por los siguientes:
- CRM (Customer Relationship Management) para administrar el proceso de interacción con los clientes, mediante el análisis de datos.
- ERP (Enterprise Resource Planning) para la planificación de recursos empresariales, manejar los negocios asociados con las operaciones de producción y distribución de bienes o servicios.
- Billing/Charge System (Sistema de cargos o facturación) para la administración de los cargos, tráfico y tarifas relacionadas con las llamadas telefónicas.
De acuerdo a la actividad y las operaciones de la empresa, a su sistema de gestión pre-existente y otros factores, relativos al control operativo, surgen diferentes opciones para la integración con la Plataforma VoIP. La elección de la interfase más adecuada depende de la información requerida por el sistema externo, para su operación, y del grado de interacción que tenga con la Plataforma VoIP.
Interfases
API (Application Programming Interface)
Los sistemas externos (3rd-part System, en el esquema siguiente) pueden comunicarse con la Plataforma VoIP a través de Interfases API (Application Programming Interface), en forma simple y segura, para el intercambio de datos.
En la siguiente imagen, el bloque indicado como API Interface incluye algunos ejemplos de sistemas de terceras partes, que pueden ser interconectados a la Plataforma VoIP.
En las centrales Nexo IPPBX, básicamente, la interfase API está orientada, a la extracción de los datos del registro CDR (Call Detail Record). Mediante la aplicación de filtros, a través de parámetros en los comandos de la interfase, permite descargar los registros CDR, según los criterios seleccionados (intervalos de fechas y horas, número de origen, número de destino, troncal de origen, troncal destino, tipo de llamada, estado, duración, etc.). La interfase API permite seleccionar los mismos criterios que pueden aplicarse en forma interactiva, cuando se visualiza el reporte CDR, desde la interfase web de la central IP. Estos comandos pueden enviarse desde un navegador o una aplicación utilizando el protocolo HTTP o HTTPS.
La interfase API que permite obtener la información correspondiente a los registros de llamadas en la Plataforma VoIP, se conoce como CDR API.
A modo de ejemplo, el formato que se utiliza para interactuar con esta interfase es el siguiente:
https://[IPPBX_IP[:Port]]/cgi/webserve/[API Command]?&[option1]=[value1]&[option2]=[value2]&...
El comando de consulta para solicitar todos los registros CDR en un determinado rango de fechas y horarios, comprende dos pasos: uno de Login y otro de Query, como se muestra a continuación:
https://192.168.1.160:4433/cgi/webserve/8404?&UserName=admin&Password=21232f297a57a5a743894a0e4a801fc3
https://192.168.1.160:4433/cgi/webserve/9006?&startdate=2026-02-01%2012:00&enddate=2026-03-01%2012:00
Para información más detallada, consultar la documentación en el siguiente link: Interfase CDR API.
AMI (Asterisk Manager Interface)
La Plataforma VoIP, cuenta además, con la Interfase AMI (Asterik Manager Interface), para monitoreo, control y administración de operaciones en la IP PBX, sobre una conexión TCP/IP.
La Interfase AMI es bidireccional, permitiendo el envío de información (tal como el registro detallado de llamadas CDR) a un sistema externo, como así también recibir comandos (en el formato standard especificado por la interfase Asterisk) para realizar operaciones, programáticamente, en la IP PBX. Esta interfase permite a programas externos conectarse a la IP PBX para monitorear eventos en tiempo real y emitir comandos.
La acción solicitada por un comando (Action Message), en esta interfase, genera una respuesta al realizar la operación, que debe enviarse al sistema externo para su procesamiento.
De manera semejante a las respuestas generadas, esta interfase, puede enviar eventos (Event Message) y notificaciones, originadas por cambios en el estado interno de la IP PBX.
Las principales características de la interfase AMI incluyen:
- Monitoreo y Control: Permite a aplicaciones de terceros (como CRMs, softphones personalizados, sistemas de atención al cliente) ver qué extensiones están ocupadas, quién llama, y gestionar llamadas (iniciar, colgar, desviar).
- Comunicación Cliente-Servidor: La interfase AMI escucha en un puerto de red (generalmente el 5038) para recibir conexiones de aplicaciones cliente que se autentican con usuario y contraseña, utilizando el protocolo de transporte TCP/IP.
- Formato de texto: Intercambia paquetes de información sencillos (Action, Response, Event). Permite enviar acciones (Actions) para originar llamadas, desviar, o colgar, y recibir eventos (Events) que informan cambios de estado en el servidor (ejemplo: una extensión cambió su estado a ocupada).
- Integración: Es muy utilizada para integrar Asterisk con sistemas de negocio para realizar funciones de "Click-to-Call", pop-ups de información del cliente al recibir una llamada, registro de llamadas o estadísticas de atención al cliente.
Esta interfase está basada en el concepto de integración del sistema telefónico con los sistemas de gestión o administración de la empresa, conocido como CTI.
Para información técnica más detallada sobre esta interfase, en las centrales Nexo IPPBX, consultar API Guide.
Para una descripción de los comandos soportados, por esta interfase, ver el siguiente enlace: The Asterisk Manager TCP IP API.
Sistemas externos
CTI (Computer Telephony Integration)
La tecnología que permite que las interacciones en un sistema telefónico y en un sistema informático puedan ser integradas o coordinadas se conoce como CTI (Computer Telephony Integration). A medida que los canales de contacto se fueron expandiendo desde la voz, para incluir e-mail, web, chat, etc., la definición de CTI se ha expandido para incluir la integración de todos los canales de contacto del cliente, con los sistemas de cómputo. Esta tecnología incorpora todas las plataformas de telefonía: analógica, digital y VoIP.
El grado de compatibilidad, con los sistemas de gestión externos BSS (Business Support Systems), que brindan apoyo a las operaciones del negocio, varía según la información requerida por cada uno de éstos y los datos disponibles en la Plataforma VoIP. Los sistemas BSS incluyen: CRM (Customer Relationship Management), ERP (Enterprise Resource Planning) y Marcador predictivo (Predictive Dialer), entre otros.
A modo de ejemplo, (VoIP System --> BSS) toda la información que se presenta en el Reporte CDR de la Plataforma VoIP, está disponible a través de la Interfase CDR API. La transferencia de estos datos al sistema de atención y gestión con el cliente (CRM), permite integrar y relacionar esta información, para obtener estadísticas, predicciones y otros elementos de marketing, que sirven como apoyo al sistema de ventas de la empresa.
En sentido contrario (BSS --> VoIP System), un sistema BSS para administración de clientes (tal como el CRM), a través de un marcador predictivo (Predictive Dialer) por medio de una Interfase AMI, una cuenta SIP (SIP Account) o un softphone, puede realizar llamadas desde el VoIP System, de acuerdo a ciertos criterios o siguiendo una agenda predeterminada.
Las ventajas más detacadas de gestionar las llamadas desde un sistema informático incluyen:
- Ventanas emergentes (screen pop-up) que permiten mostrar automáticamente toda la información relevante del cliente, en el CRM, cuando se identifica una llamada entrante,
- Marcación mediante un click (click-to-dial) para llamar a un cliente haciendo click en su número de teléfono desde el CRM o desde un navegador,
- Gestión de colas y enrutamiento automático de llamadas (queues & Automatic Call Distribution) permite dirigir las llamadas, automáticamente, a un determinado agente basado en criterios pre-configurados (el más calificado para esa tarea o consulta, etc.),
- Registro automático de atención (Call Detail Register) guarda notas auxiliares, grabaciones de llamadas (CRS) y datos del registro detallado de llamadas (CDR), en el CRM, para la trazabilidad y el seguimiento de la atención al cliente,
- Uso de teléfonos virtuales (softphones & webphones) permite la gestión de llamadas desde la PC, en lugar de utilizar otro dispositivo físico, para facilitar la automatización de tareas.
Algunas de las funciones mencionadas pueden estar integradas en la central IPPBX, tal como IVR, ACD, CTI y CRS. En ese caso, la gestión completa de la llamada (Voice + Call Control) puede hacerse a través de una interfase AMI (como se observa en la siguiente imagen).
Los siguientes links son referencias* a sistemas externos:
IMPORTANTE:
*Los contenidos en los links a sitios externos, que se mencionan en esta sección, son responsabilidad de sus editores y publicadores.
Toda consulta al respecto debe ser dirigida a los administradores de los respectivos sitios.
- Sistemas de tarifación de código abierto: Open Source Billing Systems
- Software de tarifación de código abierto: Best Open Source VoIP Billing Software
- Sistema tarifador de llamadas: A2Billing
- Sistema tarifador de llamadas: ASTPP
- Sistema tarifador de llamadas: Freeside
- Sistema tarifador de llamadas: Hydra
- Sistema tarifador de llamadas: TimelyBill
Transferencia de datos
CDR API (Call Detail Record Application Programming Interface)
En los sistemas telefónicos, CDR es el registro que contiene la información detallada de las llamadas. También es conocido como Call Logs (registros de llamadas).
Este registro incluye detalles tales como: la fecha y hora de la llamada, su duración, información sobre el origen y el destino, el enrutamiento utilizado, etc. Toda esta información puede ser utilizada por los sistemas de gestión de la empresa para marketing, con fines estadísticos, para facturación, para mediciones de rendimiento, etc.
De acuerdo al tipo de información y a la frecuencia con que se requieren estos datos, en el sistema de gestión externo, a partir de los registros de llamadas, puede realizarse la transferencia a través de
- un proceso en batch (lotes de datos en archivos), o
- un proceso contínuo (interfase de datos).
Como ejemplo de proceso en batch (que puede ser automatizado por medio de scripts), realizando una consulta en la IPPBX, por medio de su interfase web (modo interactivo), se obtiene una tabla de datos con el siguiente resultado, desde la opción: Reportes > Reporte CDR:
Desde esta pantalla, que además dispone de filtros para modificar la consulta (lo cual permite modificar el contenido en el lote de datos), puede verse la opción Descargar los registros. Esta opción permite obtener un archivo con el resultado de la consulta realizada.
Dependiendo del tráfico de llamadas y cuando la frecuencia con que se requieren los datos (lo cual es dependiente de la utilización y el procesamiento de la información por parte del sistema de gestión) no es demasiado alta, tal como diaria, semanal, quincenal o mensual, puede utilizarse este proceso en batch, como una opción para transferir la información desde la Plataforma VoIP al sistema de gestión externo.
En caso contrario, cuando la frecuencia de actualización de los datos es más elevada o se requiere por demanda, para consolidar un período de tiempo determinado, tal como puede ocurrir en los sistemas de gestión hotelera (PMS), puede resultar más conveniente utilizar un proceso de transferencia contínuo, como el que se obtiene a través de la Interfase CDR API.
Revisión: 27/04/2026 - 19/12/2022