Search
Close this search box.

< / >

APIs Reports Manager

14. Event by total agent

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=agent_14&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report indicates in detail the auxiliary statuses through which all the agents of the operation have passed, listing the start and end date of the auxiliary status, the call ID, the type of call, the destination and the telephone number.

Benefit:

This report allows an evaluation of the individual productivity of the agents taking into account the time used in each of the auxiliary states and the details of each event, to know customer management times or use of time in general.

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: {{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

NAME DESCRIPTION TYPE
api Type of report required String
date_ini Inicial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
agent_id Refers to the numeric ID of each wolkvox user Agent String
agent_status Agent’s status. This column provides default values (Ready, Talk, and ACW) as well as operation-specific custom states. String
time Indicates the total elapsed time String
date_ini Start date String
date_end End date String
conn_id Corresponds to the call identification number String
type_interaction This is the type of call, and its possible values could be: conference (conference call), inbound (incoming call), internal call (internal call), internal call_inb (internal incoming call), internal call_que (internal call from a queue), out_pre (outbound call in predictive campaign), outbound_ma (outbound call manually initiated), and transfer (transfer call). String
destinity Indicates the destination of the call String
telephone Indicates the telephone number to which the call was made String
campaign_id Corresponds to the identification number of the campaign String
agent_dni Agent identification number String
agent_name Name of the agent String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=agent_14&date_ini={{date_ini}}&date_end={{date_end}}',
  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": "1 records were found",
    "data": [
        {
            "agent_id": "",
            "agent_status": "",
            "time": "",
            "date_ini": "",
            "date_end": "",
            "conn_id": "",
            "type_interaction": "",
            "destinity": "",
            "telephone": "",
            "campaign_id": "",
            "agent_dni": "",
            "agent_name": ""
        }
    ]
} 

				
			
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