Cómo debo consumir las Api de agentes
Table of Contents
Síntoma / Necesidad
El cliente necesita integrar las funciones de wolkvox Agent (Agentbox) en sus aplicaciones externas mediante APIs, optimizando el flujo de trabajo del agente sin depender del acceso directo al aplicativo.
Contexto / Escenarios
Las APIs de agentes permiten realizar tareas habituales de wolkvox Agent (Agentbox) directamente desde aplicaciones externas o desarrollos personalizados. Estas acciones automatizan procesos como marcar, colgar, o cambiar el estado del agente, facilitando la autogestión y aumentando la eficiencia operativa.
Escenarios comunes:
- Automatizar llamadas salientes y colgar sin intervenir directamente en el aplicativo.
- Cambiar el estado del agente (Ready, Logout, ACW) desde una aplicación externa.
- Realizar transferencias y llamadas auxiliares manteniendo la relación con el cliente.
- Manejar la visibilidad del aplicativo wolkvox Agent (Agentbox).
Respuesta (Solución / Recomendación)
Configuración inicial
Para habilitar el uso de las APIs, es necesario que el administrador siga estos pasos en la configuración de integraciones:
- Ir a Configuración > Integraciones > Pestaña Integración Web.
-
Habilitar los siguientes checks:
- Activar API wolkvox Agent (Agentbox) puerto: Ingresar el puerto de conexión (por defecto: 80).
- Activar API v2 wolkvox Agent (Agentbox).
- Guardar los cambios.
Ejemplo de consumo de API: Marcar
Si el puerto configurado es 80, la URL para realizar una llamada sería:
http://localhost:80/apiagentbox?action=dial&phone=945109000&id_customer=98629699
Desglose de parámetros:
- phone: El número de teléfono del cliente (incluir prefijo si aplica).
- id_customer: La identificación del cliente.
Ejemplo ajustado: Supongamos que el prefijo de las llamadas es 9 y el número del cliente es 3104384735 con identificación 1216716845:
http://localhost:80/apiagentbox?action=dial&phone=93104384735&id_customer=1216716845
Ejecute esta URL mientras el aplicativo wolkvox Agent (Agentbox) del agente esté abierto, y la llamada comenzará automáticamente.
Listado de APIs disponibles
- Marcar: Realiza una llamada desde el wolkvox Agent (Agentbox).
- Colgar: Finaliza una llamada activa.
- Codificar: Asigna un código de gestión a una llamada finalizada.
- Reprogramar llamada predictiva: Configura una nueva llamada desde un predictivo.
- Colgar - Codificar - Ready: Combina las tres acciones en un solo consumo.
- Wolkvox Agent Visible / Invisible: Alterna la visibilidad de wolkvox Agent (Agentbox).
- Ready: Cambia el estado del agente a Ready.
- Logout: Cierra sesión del agente.
- Mute: Silencia el micrófono del agente.
- Hold: Coloca una llamada en espera.
- Realizar llamada auxiliar: Inicia una llamada auxiliar manteniendo la relación con el cliente.
- Presionar teclado DTMF: Ejecuta tonos DTMF desde aplicaciones externas.
- Transferencia: Realiza una transferencia de llamada.
- Marcar con ID y Nombre: Adjunta el ID y nombre del cliente para futuras transferencias.
- Codificar registros en campañas preview: Gestiona registros en campañas preview.
- ACW: Cambia el estado del wolkvox Agent (Agentbox) a ACW.
Nota importante:
Para consumir cualquier otra API, solo debe reemplazar los valores requeridos en la URL correspondiente.
Enlace a la documentación completa de las APIs de agentes: https://www.wolkvox.com/api-agentes/#
Consejo: Mantenga siempre el wolkvox Agent (Agentbox) abierto al consumir las APIs para asegurar que las acciones se ejecuten correctamente.