fbpx

< / >

APIs Campaign

6. Solicitar detalle de la campaña

URL:

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

Descripción:

Esta API permite conocer el estado de los registros de la campaña elegida dentro del rango de tiempo seleccionado, para almacenar en una plataforma externa o BI.

Beneficio:

Con frecuencia es necesario saber el estado de los registros de una campaña para almacenarlos en un sistema de BI, o CRM y tener una mejor visualización de la información.

Cómo funciona:

  • 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
type_campaign (URL) Tipo de campaña String
campaign_id (URL) Se refiere a la identificación numerica de la campaña String
date_ini (URL) Fecha Inicial (YYYYmmddHHiiss) String
date_end (URL) Fecha Final (YYYYmmddHHiiss) String
RESPONSE
NAME DESCRIPTION TYPE
customer_name Nombre del cliente String
customer_last_name Apellido del cliente String
id_type Tipo de identificación String
customer_id Numero de identificación del cliente String
age Edad String
gender Género String
country Pais de residencia String
state Estado de residencia String
city Ciudad de residencia String
zone Zona de residencia String
address Dirección de residencia String
opt# Campo adicional donde se ingresa información adicional de la campaña String
tel# Numero de teléfono (preview 3 tel# / predictive 10 tel#) String
tel_extra Teléfono extra String
agent_id Se refiere a la identificación numerica de cada uno de los usuarios de wolkvox Agente String
date Indica la fecha con formato año-mes-día-hora String
calls Indica la cantidad de llamadas realizadas String
conn_id Corresponde al número de identificación de la llamada String
recall Fecha de llamada de recuerdo String
result Es el resultado obtenido luego de la llamada a este contacto String
cod_act Es el ID del código de tipificación o codificación usado por el agente para una tarea general String
cod_act_2 Es el ID del código de tipificación o codificación usado por el agente para una tarea específica. String
recall_count Indica la cantidad de llamadas de recuerdo String
comments Comentarios 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/campaign.php?api=detail&amp;type_campaign={{type_campaign}}&amp;campaign_id={{campaign_id}}&amp;date_ini={{YYYYmmddHHiiss}}&amp;date_end={{YYYYmmddHHiiss}}',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "customer_name": "",
            "customer_last_name": "",
            "id_type": "",
            "customer_id": "",
            "gender": "",
            "country": "",
            "state": "",
            "city": "",
            "zone": "",
            "address": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "tel1": "",
            "tel2": "",
            "tel3": "",
            "tel4": "",
            "tel5": "",
            "tel6": "",
            "tel7": "",
            "tel8": "",
            "tel9": "",
            "tel10": "",
            "tel_extra": "",
            "agent_id": "",
            "date": "",
            "calls": "",
            "conn_id": "",
            "recall": "",
            "result": "",
            "cod_act": "",
            "cod_act_2": "",
            "recall_count": "",
            "comments": ""
        }
    ]
}
				
			

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