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

< / >

APIs Configuration

4. Desactivar agente

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=disable_agent

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 desactivar un agente en el configuration, para que este no pueda loguearse de nuevo en el wolkvox Agente.

Beneficio:

Desactive temporalmente un agente para que este no pueda loguearse durante algún periodo específico como vacaciones, licencias o suspensiones.

Cómo funciona:

  • El consumo de esta API se realiza por método PUT.
  • En el json se agregan los parametros de acuerdo a la operación o proceso a realizar.
  • 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.
  • 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.

Request

NAME DESCRIPTION TYPE
agent_id Se refiere a la identificación numérica. String

Response

NAME DESCRIPTION TYPE
code Código de respuesta. int
error Error. String
msg Descripción de 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/configuration.php?api=disable_agent',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "agent_id": "{{agent_id}}"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "xxxxx agent has been disabled"
}
				
			

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