URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns
Descripción:
Este reporte entrega una visión completa en tiempo real de la gestión de las campañas, entrega información sobre la contactabilidad, estado, penetración y otro tipo de información funcional para la gestión de las misma.
Beneficio:
Este reporte permite hacer una medición de la calidad de las campañas de acuerdo a las métricas estandarizadas que este arroja.
Cómo funciona:
- El consumo de esta API se realiza por método GET.
- Para consumir esta API debe reemplazar en la url {{wolkvox_server}} por la nomenclatura del servidor de la operación.
- Se debe hacer uso del header wolkvox-token para hacer uso de el token de autorización.
- Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
- En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.
| REQUEST |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| api | Tipo de reporte requerido | String |
| RESPONSE |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| campaign | Arroja información del id de la campaña, nombre y porcentaje de marcación según el teléfono | String |
| speed | Hace referencia a la velocidad de la campaña | String |
| status | Detalla el estado de la campaña | String |
| skill_id | Indica el número de skill vinculado a la campaña | String |
| records | Número total de registros en la campaña | String |
| clean | Cantidad de registros sin llamar | String |
| dial | Cantidad de registros marcados | String |
| answer | Indica la cantidad de registros contestados | String |
| no_answer | Indica la cantidad de registros no contestados | String |
| busy/congestion/failed | Hace referencia a los registros en busy, congestion y failed | String |
| answer_machine | Resultados de registros de máquina | String |
| penetration_day | Penetración del día de la campaña | String |
| penetration_now | Penetración del momento a la hora de consumo de la campaña | String |
| hits | Indica la cantidad de registros tipificados como “hits” | String |
| calls_x_min | Llamadas por minuto en la campaña | String |
| recycled | Cantidad de veces que se ha reciclado la campaña | String |