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

< / >

APIs

7. Reporte tiempo real de campañas

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns

Ejemplos de código:

En nuestro workspace de Postman (da clic aquí para ir), tienes acceso a ejemplos de código que facilitan la integración con nuestras APIs en diferentes lenguajes de programación, como cURL, Python, JavaScript, y más.

Esta funcionalidad es ideal para integraciones rápidas y permite adaptar los llamados a la API según el lenguaje de programación de tu sistema.

Cómo Usar los Ejemplos de Código:

  1. Navega a nuestro workspace en Postman.
  2. Selecciona la API que deseas consultar.
  3. Edita los parámetros necesarios de la API según tus objetivos.
  4. En la pestaña de “Code”, selecciona el lenguaje de tu preferencia.
  5. Obtendrás un fragmento de código autogenerado, listo para usarse con los parámetros y autenticación configurados anteriormente.

 

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: {{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.
  • Límite de registros que se pueden bajar por consumo: 60,000 registros.
  • Límite de registros que se pueden subir por consumo: 10,000 registros.
  • Límite de días consultados en fechas: 31 días.
  • Límite de peso del resultado: 256 MB.
  • Límite de tiempo de consumo del API: 60 segundos.
  • Límite de consumo simultáneo de un token: 2 solicitudes simultáneas.
  • Límite diario de tokens: Número de licencias multiplicado por 1000 tokens diarios.

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. Puede arrojar el valor “started” para cuando está ejecutándose o “stopped” cuando está detenida. 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 la cantidad de 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 => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns',
  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_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					[
        {
            "campaign": "",
            "speed": "",
            "status": "",
            "skill_id": "",
            "records": "",
            "clean": "",
            "dial": "",
            "answer": "",
            "no_answer": "",
            "busy/congestion/failed": "",
            "answer_machine": "",
            "penetration_day": "",
            "penetration_now": "",
            "hits": "",
            "calls_x_min": "",
            "recycled": ""
        } 
]
				
			

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