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

< / >

APIs Reports Manager

3. Intelligent standby detail

URL:

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

Description:

This report allows you to consult the details of the interactions that used the intelligent hold service. For each of the calls, the outbound and outbound date is indicated to calculate the time between contacts, details if the contact was successful, attempts and dialed number, as well as the duration and billed minutes.

Benefit:

The intelligent standby functionality is automatically activated when the target service level is at risk, this report allows to follow up on each of the calls that used this functionality.

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.

REQUEST

NAME DESCRIPTION TYPE
api Type of report required String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

RESPONSE

NAME DESCRIPTION TYPE
skill_id Corresponds to the identification number of the skill String
date_inbound_call Indicates the exact date on which the customer contacted by phone String
date_last_outbound_call Indicates the exact date on which the system communicated with the customer. String
status It indicates the current state of the Intelligent Callback Service. This column can have the following values:
– YES: When the customer accepts the callback.
– NO: When the customer declines the callback and chooses to wait in line.
– OK: When the customer accepted the callback, and it was successful.
– NO USER: When the person answering the callback states they are not the one who left the message, indicating their name.
– STOP NEW: When the customer accepts the callback but called again before being contacted and was attended to. Therefore, the callback would not be initiated.
– FAIL: This state indicates that all callback attempts were made but contact was never achieved.
String
attempts Indicates the number of attempts the system made to contact the customer. String
ani Indicates the telephone number from which the customer contacted you. String
dial_phone Telephone number registered by the customer for call back String
time_between_calls Refers to the time elapsed between the customer’s call and the system’s callback. String
time Indicates total elapsed time String
billed_minutes Total billed minutes String
customer_id Corresponds to the customer’s 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_3&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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": [
        {
            "skill_id": "",
            "date_inbound_call": "",
            "date_last_outbound_call": "",
            "status": "",
            "attempts": "",
            "ani": "",
            "dial_phone": "",
            "time_between_calls": "",
            "time": "",
            "billed_minutes": "",
            "customer_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