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

< / >

APIs Configuration

4. Deactivate agent

URL:

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

Description:

This API allows you to deactivate an agent in the configuration, so that it cannot log in to the wolkvox Agent again.

Benefit:

Temporarily disable an agent from logging in during specific periods such as vacations, leaves of absence or suspensions.

How it works:

  • The consumption of this API is done by PUT method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.

REQUEST

NAMEDESCRIPTIONTYPE
agent_idRefers to the numerical identificationString

RESPONSE

NAMEDESCRIPTIONTYPE
codeResponse codeint
errorErrorString
msgDescription of the responseString

Possible response codes
				
					$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": ""
}',
  CURLOPT_HTTPHEADER => 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"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data