fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Reports Manager

10. Cobrowsing

URL:

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

Description:

This report allows you to view the details of each assistance session conducted using the cobrowsing tool by the agents in the operation.

Benefit:

Obtain detailed information about each agent who has provided assistance via the “cobrowsing” tool.

How it works:

  • The consumption of this API is done via the GET method.
  • To use this API, you must replace {{wolkvox_server}} in the URL with the server nomenclature of the operation.
  • The wolkvox-token header must be used to utilize the authorization token.
  • Please note that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the previous one is successful.
  • In terms of timing, you can consume the information every 5 minutes to monitor your operation.
  • 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 Start date (YYYYmmddHHiiss). String
date_end End date (YYYYmmddHHiiss). String

Response

NAME DESCRIPTION TYPE
code Response code. Int
error Indicates if there was an error or not. String
msg Number of messages found. String
agent_id Identification Number or Extension of the Agent within the wolkvox Manager System. String
agent_name Agent name. String
date_ini Start Date and Time of the Cobrowsing Session. String
date_end End Date and Time of the Cobrowsing Session. String
time Total Duration of the Session. String
hung_up Indicates whether the client or the agent ended the call first. 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?date_ini={{date_ini}}&date_end={{date_end}}&api=cdr_10',
  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-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "x records were found",
    "data": [
        {
            "agent_id": "",
            "agent_name": "",
            "date_ini": "",
            "date_end": "",
            "time": "",
            "hung_up": ""
        }
    ]
}
				
			
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