URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=campaign_15&campaign_id={{campaign_id}}

Descripción:

Esta API permite a los usuarios obtener de manera programática todos los registros asociados a una campaña (Predictiva/Progresiva o Preview) específica en Wolkvox Manager. Esta funcionalidad incluye tanto los registros que han sido gestionados (contactados con un resultado) como los no gestionados, así como aquellos que tienen o no un conn_id (identificador de conexión).

Esta API garantiza que la información exportada sea completamente consistente con los datos que se obtendrían a través de la opción de exportación directa desde la interfaz de usuario de Wolkvox Manager, lo que asegura la integridad y fiabilidad de los datos al integrarlos con otros sistemas o para análisis externos.

Beneficio:

• Automatización de la extracción de datos: Permite automatizar la descarga de los registros de campaña, eliminando la necesidad de exportaciones manuales periódicas.
• Consistencia de la información: Asegura que los datos obtenidos mediante la API son idénticos a los que se exportarían manualmente desde el Manager, garantizando la fiabilidad.
• Visibilidad completa:  Proporciona acceso a todos los registros de la campaña, incluyendo gestionados y no gestionados, permitiendo un análisis exhaustivo del rendimiento de la campaña.
• Eficiencia operativa:  Reduce la carga de trabajo manual y los posibles errores asociados a la manipulación de grandes volúmenes de datos.

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.
• Reemplaza {{type_campaign}} en la URL con el tipo de campaña asignado a la campaña de la cual deseas obtener información detallada. Puede tomar el valor “predictive” o “preview”.
• Reemplaza {{campaign_id}} en la URL con el código de identificación de la campaña.
• Reemplaza {{YYYYmmddHHiiss}} en la URL con la fecha de inicio (date_ini) y la fecha de fin (date_end) en el formato “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.

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.

Request

Response