fbpx

< / >

APIs

8. List agents in skill

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=agents_in_skill&skill_id={{skill_id}}

Description:

This API allows to have information about the agents that are related to the requested skill.

Benefit:

It allows to have basic information such as agent’s extension number, name, last login and level of expertise.

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.
  • You must replace in the url {{skill_id}} by the identification number of the skill you want to obtain the information.
  • Use the wolkvox-token header 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

NAME DESCRIPTION TYPE
api Type of report required String

Response

NAME DESCRIPTION TYPE
agent_id This is the extension number that is assigned to each wolkvox Agent user. String
agent_name This is the name assigned to each wolkvox Agent user. String
last_use Date and time of agent’s last login String
expertise Level of expertise assigned to the agent in the skill consulted 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_in_skill&skill_id={{skill_id}}',
  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": "200",
    "error": null,
    "msg": "  records were found",
    "data": [
        {
            "agent_id": " ",
            "agent_name": " ",
            "last_use": " ",
            "expertise": " "
        },
        {
            "agent_id": " ",
            "agent_name": " ",
            "last_use": " ",
            "expertise": " "
        }
    ]
}
				
			

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

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