Search
Close this search box.

< / >

APIs Reports Manager

5. Agents

URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=agents

Description:

This API allows to have information about the Agents.

Benefit:

It allows to have basic information such as last connection, status and skill to which the agents belong.

How it works:

  • The consumption of this API is done by GET method.
  • 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.
  • In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.
  • 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

NAMEDESCRIPTIONTYPE
apiType of report requiredString

Response

NAMEDESCRIPTIONTYPE
agent_idThis is the numerical user number assigned to each wolkvox Agent user.String
agent_nameThis is the name assigned to each wolkvox Agent user.String
agent_dniIt is the identification document of each wolkvox Agent user.String
agent_statusAgent status.String
last_useDate of last connection.String
agent_ssoNetwork username for Single Sign-On (SSO) function.String
enabledIndicates whether the user is enabled or disabled. It can return the value “yes” or “no”.String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=agents',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "",
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "agent_id": "",
            "agent_name": "",
            "agent_dni": "",
            "agent_status": "",
            "last_use": "",
            "agent_sso": ""
        }
    ]
}
				
			
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