fbpx

< / >

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 {ip_ipdialbox} for the nomenclature of the server of the operation and the {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.

NAMEDESCRIPTIONTYPE
apiType of report requiredString
date_iniInitial Date(YYYYmmddHHiiss)String
date_endFinal Date(YYYYmmddHHiiss)String
customer_idThis corresponds to the customer‘s identification number.String

NAMEDESCRIPTIONTYPE
rp_idrefers to the numerical identification of the routing pointString
rp_nameName of the routing pointString
cod_opc_menuIndicates the menu option chosen by the customer in the IVRString
dn_transferIndicates where the call is routed after the customer dials an optionString
dateIndicates the date in the yearmonthdayhour formatString
resultShows the result of the customer‘s interaction with the IVR, where it can be verified if the customer hangs up or reaches the agent queue satisfactorilyString
aniIt is the telephone number from which the inbound call originates (Automatic Number Identification)String
timeIndicates duration of interactionString
customer_idIt corresponds to the customer‘s identification numberString
conn_idIt corresponds to the call identification numberString

 

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={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}&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-token: {{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