fbpx

< / >

APIs Configuration

4. Desactivar agente

URL:

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

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 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.
REQUEST
NAMEDESCRIPTIONTYPE
agent_idSe refiere a la identificación numéricaString
RESPONSE
NAMEDESCRIPTIONTYPE
codeCódigo de respuestaint
errorErrorString
msgDescripción de la respuestaString
Posibles códigos de respuesta
				
					 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=disable_agent',
  CURLOPT_RETURNTRANSFER =&gt; true,
  CURLOPT_ENCODING =&gt; '',
  CURLOPT_MAXREDIRS =&gt; 10,
  CURLOPT_TIMEOUT =&gt; 0,
  CURLOPT_FOLLOWLOCATION =&gt; true,
  CURLOPT_HTTP_VERSION =&gt; CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =&gt; 'PUT',
  CURLOPT_POSTFIELDS =&gt;'{
    "agent_id": ""
}',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{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