Síntoma / Necesidad

El cliente necesita consumir un API de Wolkvox para obtener reportes que faciliten la integración con aplicaciones externas, como CRM, ERP o herramientas de Business Intelligence.

Contexto / Escenarios

Wolkvox ofrece múltiples APIs seguras a través de HTTPS para realizar integraciones. Estas APIs permiten extraer información valiosa para análisis y seguimiento operativo. Un ejemplo común es el reporte "Agente tiempo por estado", que muestra la actividad detallada de los agentes.

Respuesta (Solución / Recomendación)

1. Acceso a la lista de APIs:
   • Ingresa al siguiente enlace para consultar la lista de APIs disponibles:
     https://www.wolkvox.com/apis-v2/.
   • En el panel izquierdo, selecciona Reports Manager.
   • Encontrarás APIs como Agents, Skills, CDR, Quality, Campaigns, Chats, entre otras.
2. Ejemplo de consumo del API "Agente tiempo por estado":
   Este reporte proporciona datos como:
   • Total de llamadas gestionadas (inbound/outbound/internal).
   • Tiempo en cada fase de atención (Ring, ACW, AHT).
   • Fecha y hora de Log In/Log Out.
   • Cantidad de hits y RPC.
3. Configuración del API:
   • Tipo de petición: GET.
   • URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}
   • Reemplaza {{wolkvox_server}} por el número del servidor.
   • Define el rango de fechas con los parámetros date_ini y date_end.
   • Ejemplo de URL configurada: https://wv0001.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini=20250128000000&date_end=20250128235959
4. Requisitos para el consumo:
   • Método: GET.
   • Reemplaza {ip del servidor} por la nomenclatura del servidor de la operación.
   • Usa un token generado desde Wolkvox Manager para la autenticación segura.
5. Cómo generar el token:
   • Ingresa a Wolkvox Manager y sigue la ruta:
     Manager > Configuración > Integraciones > Token.
   • Crea un nuevo token o selecciona uno existente.
   • Este token se incluirá en el header como wolkvox-token para autenticar el consumo.
6. Funcionamiento del API:
   • El consumo debe realizarse cada 5 minutos (tiempo recomendado) para obtener datos actualizados.
   • Un mismo token no puede ser usado simultáneamente en diferentes solicitudes. Asegúrate de esperar una respuesta exitosa antes de consumir la siguiente API.
7. Respuesta esperada:
   • Si el consumo es exitoso, la API devolverá un código 200 con un mensaje como el siguiente:

{

    "code": 200,

    "error": null,

    "msg": "1 records were found",

    "data": [

        {

            "agent_id": "",

            "agent_dni": "",

            "agent_name": "",

            "aux_state": "",

            "time": ""

        }

    ]

}

7. En caso de errores:
   • Si obtienes un código diferente a 200, consulta el siguiente enlace para identificar y solucionar el error:
     https://www.wolkvox.com/codigos-de-respuesta-api/.

Nota: Este procedimiento está diseñado para facilitar la integración y garantizar un consumo eficiente de las Apis de Wolkvox.