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

< / >

APIs Agent

Programar rellamada en predictivo

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=recall&customer_phone={{customer_phone}}&date={{YYYYmmddHHiiss}}&type_recall={{type_recall}}

Descripción:

Esta API permite programar rellamadas en campañas predictivas.

Beneficio:

Al usar esta API obtienes facilidad en la gestión y seguimiento de las comunicaciones con los clientes, optimización del tiempo, mejora en la experiencia del cliente, automatización de procesos y mayor control.

¿Cómo funciona?

  • El consumo de esta API se realiza mediante el método POST.
  • Reemplaza {{wolkvox_server}} en la URL por la nomenclatura de su operación en el servidor.
  • Debes reemplazar {{agent_id}} por el número de extensión asignado al agente en el sistema wolkvox.
  • Debes reemplazar {{customer_phone}} por el teléfono del cliente.
  • Debes reemplazar {{YYYYmmddHHiiss}} por la fecha en que se debe ejecutar la rellamada. Debe estar en formato YYYYmmddHHiiss como por ejemplo:  20231122101520 Siendo “YYYY” el año, “mm” el mes, “dd” el día, “HH” la hora en formato militar, “ii” los minutos y “ss” los segundos.
  • Reemplaza {{type_recall}} por el tipo de rellamada que deseas establecer, puede aceptar el valor “auto” para hacer la rellamada de manera automática o “manual” para que sea el agente quien deba hacer la rellamada manualmente.
  • Debes usar  “wolkvox-token: {{token}}” en el HEADER y reemplazar  {{token}} por el token de autorización generado en su operación de wolkvox.
  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultánea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • Las APIs v2 de agente requieren un token de autenticación para su acceso, sin embargo, el uso de este token no afecta el consumo asignado. Es importante destacar que todas las demás restricciones y límites establecidos para el consumo de las APIs siguen siendo aplicables al utilizar las APIs v2 de agente.
  • 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.
  • Nota: Esta API es compatible con wolkvox Agent de escritorio y versión web.

 

REQUEST
NAME DESCRIPTION TYPE
token Código de token generado en el aplicativo wolkvox Manager. INT
wolkvox_server Nomenclatura del servidor en el que se encuentra su operación. Este código es proporcionado por personal de soporte. INT
agent_id Número de extensión del agente asignado en el sistema wolkvox. INT
customer_phone Número de teléfono del cliente. INT
date

Fecha en que la cual se debe ejecutar la rellamada. Debe estar en formato YYYYmmddHHiiss como por ejemplo:  20231122101520

Siendo “YYYY” el año, “mm” el mes, “dd” el día, “HH” la hora en formato militar, “ii” los minutos y “ss” los segundos.

String
type_recall Tipo de rellamada que deseas establecer, puede aceptar el valor “auto” para hacer la rellamada de manera automática o “manual” para que sea el agente quien deba hacer la rellamada manualmente. INT
RESPONSE
NAME DESCRIPTION TYPE
code Indica el código de estado de la respuesta. INT
error Proporciona información detallada sobre cualquier error que pueda haber durante la ejecución de la API. El valor “null” indica que no se produjeron errores y que la ejecución de la API fue exitosa. String
msg Es un mensaje informativo que describe la respuesta. String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=recall&customer_phone={{customer_phone}}&date={{date}}&type_recall={{type_recall}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  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": "Recall has been successful"
}
				
			

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