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

< / >

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}}

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:

Obtén información detallada sobre las campañas tanto predictivas/progresivas como preview. Esta información incluye datos importantes para monitorear y hacer seguimiento a cada campaña mediante el histórico obtenido. Esta información se puede utilizar para mejorar la efectividad de las campañas y proporcionar un mejor servicio a los clientes.

Beneficio:

Ofrece un acceso detallado y completo a la información de campañas, abarcando tanto las predictivas/progresivas como las de vista previa. Este recurso proporciona datos cruciales para la supervisión y seguimiento detallado de cada campaña, a través del análisis del historial acumulado. Esta información se revela como una herramienta invaluable para potenciar la eficacia de las campañas, permitiendo así brindar un servicio aún más efectivo y personalizado a los clientes.

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.
  • Replace {{type_campaign}} in the URL with the campaign type assigned to the campaign from which you want to retrieve detailed information. It can take the value “predictive” or “preview”.
  • Replace {{campaign_id}} in the URL with the campaign identification code.
  • Replace {{YYYYmmddHHiiss}} in the URL with the start date (date_ini) and end date (date_end) in the format “YearMonthDayHourMinuteSecond”.
  • 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.
  • Esta API solo retornará información de registros que contengan “conn_id”, lo que significa que han sido gestionados en algún momento.

Request

NAME DESCRIPTION TYPE
type_campaign (URL) Tipo de campaña. String
campaign_id (URL) Se refiere al código de identificación 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 del cliente. String
customer_id Número de identificación del cliente. String
age Edad. String
gender Género. String
country País de residencia. String
state Estado o departamento de residencia. String
city Ciudad de residencia. String
zone Área de residencia. String
address Dirección de residencia. String
opt# Campos adicionales a los predeterminados. String
tel# Números de teléfono del cliente (Campañas de tipo preview llegan hasta tel3 / Campañas de tipo predictivo llegan hasta tel10). String
tel_extra Campo de teléfono extra a los adicionales. String
agent_id Se refiere al número de extensión o identificación del agente en el sistema wolkvox. String
date Indica la fecha en formato Año-Mes-Día. String
calls Indica el número de llamadas hechas. String
conn_id Corresponde al código de identificación de la llamada. String
recall Fecha de rellamada. String
result Es el resultado obtenido en la última llamada. String
cod_act Se refiere al código de actividad usado por el agente para tipificar o codificar la llamada. String
cod_act_2 Se refiere al segundo código de actividad usado por el agente para tipificar o codificar la llamada. String
recall_count Indica el número de veces que se ha llamado. String
comments Comentarios dejados por el agente en sus tipificaciones. String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=detail&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}&date_ini={{date_ini}}&date_end={{date_end}}',
  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

				
					{
    "code": "200",
    "error": null,
    "msg": "x 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

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