Search
Close this search box.

< / >

APIs Reports Manager

2. Agent per event – Select agent

URL:

https://{{wolkvox_server}}/api/v2/reports_manager.php?api=agent_2&agent_id={{agent_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report indicates in detail the auxiliary statuses through which an agent has passed, listing the start and end date of the auxiliary status, the call ID, the type of call, the destination and the telephone number. It is important to note that the auxiliary statuses are parameterized according to the needs of the operation.

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 server nomenclature of the operation and the {{token}} generated from wolkvox Manager to obtain the information in a secure way.
  • 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

NOMBRE DESCRIPTION TYPE
api Type of report required String
agent_id Agent Code String
date_ini Initial Date String
date_end Final Date String

Response

NAME DESCRIPTION TYPE
agent_id Refers to the numeric user that is assigned to each wolkvox Agent user String
agent_status Details the agent’s auxiliary status String
time Indicates total elapsed time String
date_ini Indicates the start date in year-month-day format. String
date_end Indicates the date of completion in year-month-day format String
conn_id Call Identification Number. String
type_interaction It 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
destiny Destination where the interaction takes place String
telephone Identification (phone or mail depending on channel) in interactions String
campaign_id campaign id String
Possible response code
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=agent_2&agent_id={{agent_id}}&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": "",
            "destiny": "",
            "telephone": "",
            "campaign_id": ""
        }
    ]
}

				
			
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