fbpx

< / >

APIs -- seleccione una opción --

7. Reporte tiempo real de campañas

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
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns',
  CURLOPT_RETURNTRANSFER =&gt; true,
  CURLOPT_ENCODING =&gt; '',
  CURLOPT_MAXREDIRS =&gt; 10,
  CURLOPT_TIMEOUT =&gt; 0,
  CURLOPT_FOLLOWLOCATION =&gt; true,
  CURLOPT_HTTP_VERSION =&gt; CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =&gt; 'GET',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{wolkvox_token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					[
        {
            "campaign": "4875 - MY CAMPAIGN - tel1 (100%)",
            "speed": "110%",
            "status": "started",
            "skill_id": "4000",
            "records": "1",
            "clean": "1",
            "dial": "0",
            "answer": "0",
            "no_answer": "0",
            "busy/congestion/failed": "0",
            "answer_machine": "0",
            "penetration_day": "0.00 %",
            "penetration_now": "0.00 %",
            "hits": "0 (0.00 %)",
            "calls_x_min": "0",
            "recycled": "0"
        } 
]
				
			

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales