fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Reports Manager

1. Campaña por maquina (Resultado-final)

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_1&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Descripción:

Este reporte permite evaluar el desempeño de la campaña teniendo en cuenta la cantidad de los registros de los resultados finales de máquina (no-answer, answer, failed, busy, congestion, recall, do-not-call-clean) y el porcentaje de estos en el total de la campaña.

Beneficio:

Permite comprender como ha sido la contactabilidad de los clientes en las campañas automáticas de outbound.

Cómo funciona:

    • El consumo de esta API se realiza por método GET.

    • Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.

    • 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
campaign_id Identificación numérica de la campaña. Puede recibir el valor “all” para indicar que deseas obtener el reporte de todas las campañas. String
date_ini Fecha Inicial (YYYYmmddHHiiss). String
date_end Fecha Final (YYYYmmddHHiiss). String

RESPONSE
NAME DESCRIPTION TYPE
result Indica el código de respuesta que obtuvo de la máquina. Los códigos de la máquina son: no-answer (no contestada), busy (línea ocupada), answer (contestada), answer-machine (contestada por una máquina), recall (rellamada), do-not-call_clean (números en lista do not call), congestion (línea congestionada) y abandon (llamada abandonada). String
records Indica la cantidad de registros para cada código de respuesta. String
percent Indica el porcentaje de registros que representa cada código de respuesta. String

Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_1&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "result": "",
            "records": "",
            "percent": ""
        }
    ]
}

				
			

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

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