fbpx

< / >

APIs Real Time

10. Consultar recalls programados en campañas

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=recall&type=all

 

Descripción:

Esta API proporciona una vista centralizada y unificada de todos los recalls (retrollamadas) programados en las campañas. Esta herramienta está diseñada para administradores e integradores que necesitan consolidar información de recalls de diversas fuentes, ya sea que hayan sido creados de forma manual, automática, a través de la API, o mediante la carga de una base de datos. Esta funcionalidad permite obtener información detallada sobre los recalls activos, sin importar su origen.

 

Beneficio:

  • Vista Unificada y Centralizada: Consolida la información de todos los recalls activos, eliminando la necesidad de buscar en múltiples fuentes.
  • Trazabilidad y Auditoría Mejoradas: Permite identificar la fecha, hora, campaña y agente asignado a cada recall, facilitando la auditoría y el seguimiento de la estrategia de contacto.
  • Control Operativo Optimizado: Proporciona datos en tiempo real para tomar decisiones operativas, como la redistribución de tareas o la identificación de cuellos de botella.
  • Integración Flexible: Facilita la integración con dashboards personalizados, sistemas de análisis externos o motores de asignación de tareas, potenciando la capacidad de gestión de la operación.
  • Planificación Estratégica: Mejora la planificación de campañas al ofrecer una visión clara de la carga de trabajo futura relacionada con los recalls pendientes.

 

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 la URL puedes usar ‘type=’ para filtrar la búsqueda con los valores “all”, “manual” o “auto”. 
  • 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.

 

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

NAME DESCRIPTION TYPE
api Tipo de reporte requerido. String

Response

NAME DESCRIPTION TYPE
code
Código de estado de la respuesta.
String
error
Información detallada sobre cualquier error que pueda haber ocurrido durante la ejecución de la API. Si no hay errores, el valor es null.
String
msg
Mensaje informativo que describe la respuesta de la API.
String
data
Arreglo que contiene los detalles de cada recall programado encontrado en la base de datos.
String
type_recall
Tipo de origen del recall. Indica cómo fue creado.
String
date_recall
Fecha y hora exactas en las que el recall está programado para ser ejecutado.
String
phone_number
Número de teléfono al que se debe realizar la retrollamada.
String
id_campaing
Identificador único de la campaña a la que pertenece el recall programado.
String
id_agent
Identificador único del agente al que se le asignó el recall.
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=recall&type=all',
  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: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "X records were found",
    "data": [
        {
            "type_recall": "",
            "date_recall": "",
            "phone_number": "",
            "id_campaing": "",
            "id_agent": ""
        },
        {
            "type_recall": "",
            "date_recall": "",
            "phone_number": "",
            "id_campaing": "",
            "id_agent": ""
        }
    ]
}
				
			

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

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