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

< / >

APIs Agent

Marcar

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=dial&customer_phone={{customer_phone}}&customer_id={{customer_id}}&customer_name={{customer_name}}

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:

Esta API permite marcar desde su aplicación interna sin desarrollos complejos.

Beneficio:

Al usar esta API obtienes facilidad de marcación, integración con aplicación interna, automatización de marcaciones, eficiencia en el proceso de llamada y mejora la experiencia del agente.

¿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 del agente asignado en el sistema wolkvox.
  • Reemplaza {{customer_phone}} por el número de teléfono del cliente.
  • Reemplaza {{customer_id}} por el número de identificación del cliente. Este campo es opcional.
  • Reemplaza {{customer_name}} por el nombre del cliente. Este campo es opcional.
  • 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 simultanea, 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 a marcar. INT
customer_id Es el número de identificación del cliente. Este campo es opcional. INT
customer_name Es el nombre del cliente. Este campo es opcional. String
RESPONSE
NAME DESCRIPTION TYPE
code Indica el código de estado de la respuesta. String
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
data Contiene el dato o conjunto de datos obtenidos al consumir la API. Es decir, almacena la información específica relacionada con la operación realizada mediante la API. JSON Object
conn_id Código de identificación de la llamada. 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=dial&customer_phone={{customer_phone}}&customer_id={{customer_id}}&customer_name={{customer_names}}',
  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": "Dial has been successful",
    "data": {
        "conn_id": ""
    }
}
				
			

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