Search
Close this search box.

< / >

APIs Reports Manager

1. IVR call detail En

URL:

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

Description:

This report allows for detailed tracking of IVR interactions taking into account the call identification, customer navigation (menu option code, DN Transfer and result), date and duration of interaction.

Benefit:

This report allows to evaluate the traceability of the IVR as a selfmanagement system for customers by knowing the detailed navigation of each of the interactions.

How it works:

  • This API is consumed by GET method.
  • To consume this API you must replace in the url {{wolkvox_server}} for the nomenclature of the server of the operation and the {{wolkvox_token}} generated from Wolkvox Manager to get the information in a secure way.
  • Use the header wolkvoxtoken to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can program that the next API is consumed when the result of the previous one is successful.
  • In terms of time, to track your operation you can consume the information every 5 minutes.

Request

NAME DESCRIPTION TYPE
api Type of report required String
date_ini Initial Date(YYYYmmddHHiiss) String
date_end Final Date(YYYYmmddHHiiss) String
customer_id This corresponds to the customer‘s identification number. String

Response

NAME DESCRIPTION TYPE
rp_id refers to the numerical identification of the routing point String
rp_name Name of the routing point String
cod_opc_menu It shows the option the customer selected in the IVR. This column may display the value “PULSE,” which means the customer didn’t manage to press an option on their keypad. String
dn_transfer Indicates where the call is routed after the customer dials an option String
date Indicates the date in the yearmonthdayhour format String
result It indicates the result of the interaction the customer has in the IVR. This column specifies whether the customer has either hung up or successfully reached the agent queue. This column can only return the values “ok” (call made) and “hung up” (call hung up). String
ani It is the telephone number from which the inbound call originates (Automatic Number Identification) String
time Indicates duration of interaction String
customer_id It corresponds to the customer‘s identification number String
conn_id It corresponds to the call identification number 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=diagram_1&date_ini={{date_ini}}&date_end={{date_end}}&customer_id={{customer_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": "1 records were found",
    "data": [
        {
            "rp_id": "",
            "rp_name": "",
            "cod_opc_menu": "",
            "dn_transfer": "",
            "date": "",
            "result": "",
            "ani": "",
            "time": "",
            "customer_id": "",
            "conn_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