Nexo Tecnología VoIP

Introducción Formato URL para CDR API Parámetros URL para CDR API Consideraciones y ejemplos

Introducción En términos generales, las interfases permiten la interconexión de la Plataforma VoIP con otros sistemas (3rd-part Systems). En la siguiente imagen, los sistema de terceras partes, a modo de ejemplo, están representados por CRM / ERP / Charge System. Los sistemas de 3ras partes 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. Una de esas interfases permite obtener la información correspondiente a los registros de llamadas en la Plataforma VoIP. Esta interfase se conoce como CDR API. Para analizar la información que puede obtenerse a través de la Interfase CDR API nos remitimos al Reporte CDR que es parte de la interfase web de la IPPBX. El Reporte CDR (Call Detail Record) está compuesto por registros de datos generados por Nexo IP PBX que contienen atributos específicos de cada instancia de llamada telefónica realizada a través del Sistema VoIP. Cada registro contiene varios campos de datos que proveen información detallada sobre la llamada, tal como el número de origen y destino de la llamada, fecha y hora de inicio, duración, dirección de la llamada, etc. En Nexo IP PBX, el Reporte CDR puede ser accedido desde la interfase web en la opción: Reportes > Reporte CDR. Este contenido puede ser filtrado, para obtener distintos resultados, especificando rango de fechas y condiciones (criterios de búsqueda), para acotar el número de registros que se muestran en el reporte. Los criterios de búsqueda que pueden aplicarse en este filtro, para el Reporte CDR, se enumeran en la siguiente tabla. Deben tenerse en cuenta todos los parámetros, en la configuración de Nexo IP PBX, que modifican los datos que aparecen en los registros CDR. Los rangos numéricos de las extensiones, de las colas ACD, de los grupos de timbrado, de los IVRs, etc, están determinados por los valores configurados en la opción: PBX Básico > Preferencias Generales > Parámetros de Extensión. Configurando nombres para los Prefijos CID, en las rutas entrantes y en los IVRs, luego pueden utilizarse como criterios de búsqueda para obtener un rango determinado de registros CDR. Por ejemplo, para modificar el Caller ID de la llamada entrante, puede utilizarse el campo Prefijo Nombre CID, en la siguiente configuración avanzada de la ruta entrante: Para información más detallada, consultar: Rutas entrantes. De manera similar, en la configuración de cada IVR, puede agregarse un prefijo al CID, utilizando el campo Prefijo Nombre CID. Para información más detallada sobre esta configuración, consultar: IVR (Respuesta Interactiva de Voz). Formato URL para CDR API El formato URL para los comandos de la Interfase CDR API se presenta en el siguiente cuadro. http://[IPPBX_IP[:Port]]/cgi/webserve/[API Command]?&[option1]=[value1]&[option2]=[value2]&... https://[IPPBX_IP[:Port]]/cgi/webserve/[API Command]?&[option1]=[value1]&[option2]=[value2]&... De acuerdo a la configuración de los Servicios en Nexo IP PBX, que pueden ajustarse desde la opción: PBX Básico > Preferencias Generales > Servicios, deben ajustarse los parámetros, para la invocación de comandos de la Interfase CDR API. Tomando como ejemplo los valores de los puertos mostrados en la imagen anterior (HTTP Port: 8080, HTTPS Port: 4433), y como dirección IP: 192.168.1.160 para Nexo IP PBX, los comandos correspondientes a cada protocolo (http y https), deberían ser: http://192.168.1.160:8080/cgi/webserve/[API Command]?&[option1]=[value1]&[option2]=[value2]&... https://192.168.1.160:4433/cgi/webserve/[API Command]?&[option1]=[value1]&[option2]=[value2]&... Cuando se utilizan los puertos por defecto (80 para HTTP y 443 para HTTPS) para los protocolos, pueden omitirse (:port) en la invocación de los comandos de la Interfase CDR API. IMPORTANTE: Los servicios correspondientes a los protocolos SSH y FTP están reservados para fábrica. Parámetros URL para CDR API Las opciones incluídas en la URI del comando de la Interfase CDR API controlan la coincidencia de registros y el formato de salida. Los parámetros pueden aparecer en cualquier orden dentro de la URI del comando. Valores múltiples para los números de origen o destino serán concatenados. En la Interfase CDR API, los comandos disponible son los siguientes: Los siguientes comandos Download CDR y Delete CDR no están disponibles en la versión standard. IMPORTANTE: Puede requerirse una actualización de firmware para habilitar los siguientes comandos. Consideraciones y ejemplos Las siguientes consideraciones son obligatorias para poder ejecutar un comando de la Interfase CDR API: Antes de realizar una consulta, debe logearse en el sistema utilizando el comando correspondiente (Login), para poder requerir datos de los registros de llamadas. El password en los comandos debe estar encriptado en formato MD5 de 32 bits. Ejemplo 1: Ingresando en el browser los datos correspondientes al comando de login: http://192.168.1.160:8080/cgi/webserve/8404?&UserName=admin&Password=21232f297a57a5a743894a0e4a801fc3 https://192.168.1.160:4433/cgi/webserve/8404?&UserName=admin&Password=21232f297a57a5a743894a0e4a801fc3 md5("admin")= 21232f297a57a5a743894a0e4a801fc3 se obtiene el siguiente resultado: La primera línea en el resultado indica que la operación de logeo fue exitosa: LoginStatus: "Success". Ejemplo 2: Solicitar todos los registros CDR en un determinado rango de fechas y horarios. Habiendo ejecutado, en primer término, el comando de Login, luego se ingresa el comando de consulta (Querying CDR): http://192.168.1.160:8080/cgi/webserve/9006?&startdate=2021-07-21%2009:00&enddate=2021-07-21%2010:00 https://192.168.1.160:4433/cgi/webserve/9006?&startdate=2021-07-21%2009:00&enddate=2021-07-21%2010:00 Ingresando en el browser el comando de consulta con sus correspondientes parámetros se procesa la solicitud. El resultado obtenido se encuentra en formato JSON. Algunos browsers permiten la visualización de los datos aplicando una plantilla con este formato, tal como puede observarse en la siguiente imagen.  Realizando la misma consulta en la IPPBX, por medio de su interfase web, se obtiene el siguiente resultado, en la opción: Reportes > Reporte CDR: donde puede observarse la correlación de valores, entre los contenidos de las columnas y de los campos en el resultado obtenido a través de la Interfase CDR API.

Versión: 1.0.8  Revisión: 10/12/2021 - 26/11/2021

Nexo VoIP © 2021