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.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME DESCRIPTION TYPE
agent_id Refers to the numerical identification String

Response

NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Description of the response String
Possible response codes

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