Search
Close this search box.

< / >

APIs Customer

3. Call CDR Report

URL:

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

Description:

This report provides a complete view of the details of the interaction, specifying the call data such as ID, type, duration, type, phone and exact date (day of the week, month, hour); it also indicates the agent who attended the interaction, the performance indicators, the services associated with the operation such as screen recording and the total cost of the call.

Benefit:

This report allows you to track call details and accounting by indicating the value of voice services consumption.

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

NAME DESCRIPTION TYPE
api API required String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
conn_id   String
type_call Call type (inbound, outbound and internal) String
talk_time Indicates the duration expressed in unit of time in seconds. String
agent_id Refers to the numerical identification of each wolkvox Agent user. String
agent_name Agent’s name String
agent_dni Refers to the identity document of each wolkvox Agent user. String
skill_id It is the numerical identification of the skill String
date Indicates the date in the format year-month -day -time String
hour Indicates in military time format String
day_of_week Indicates the day of the week String
cod_act It is the ID of the coding or classification code used by the agent. It can return the value “TIMEOUTACW” if the operation has the timing of the coding process active and the agent exceeded the time limit to code the interaction. String
description_cod_act Indicates the description of the type code String
cod_act_2 It is the ID of the coding or classification code used by the agent. It can return the value “TIMEOUTACW” if the operation has the timing of the coding process active and the agent exceeded the time limit to code the interaction. String
description_cod_act_2 Indicates the description of the type code String
hit Agent performance indicator that indicates achievement or successful sale. String
telephone_destination Indicates the destination telephone number to which the call was made String
telephone_costs Indicates the cost for the use of telephony. String
telephone Indicates the telephone number to which the call was placed String
hang_up It shows who hung up the call, whether it was the agent (agent) or the customer (customer). String
customer_id Corresponds to the customer’s identification number String
month Indicates in number the month of interaction String
screen_recording It indicates if the interaction used the screen recording functionality (yes) or not (no). String
operation Indicates the name of the operation String
ring Indicates the time elapsed from the time the call is dialed to the time it is answered String
abandon It is the result of inbound calls hung up by the client prior to the consultant’s attention. String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/customer.php?api=cdr_calls&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": [
        {
            "conn_id": "",
            "type_call": "",
            "talk_time": "",
            "agent_id": "",
            "agent_name": "",
            "agent_dni": "",
            "skill_id": "",
            "date": "",
            "hour": "",
            "day_of_week": "",
            "cod_act": "",
            "description_cod_act": "",
            "cod_act_2": "",
            "description_cod_act_2": "",
            "hit": "no",
            "telephone_destination": "",
            "telephone_costs": "",
            "telephone": "",
            "hang_up": "",
            "customer_id": "",
            "month": "",
            "screen_recording": "",
            "operation": "microdllo",
            "ring": "--",
            "abandon": "--"
        }
    ]
} 

				
			
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