fbpx

< / >

APIs Reports Manager

7. NLP Detail

URL:

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

Description:

This report delivers in detail a report about the use of NLP or artificial intelligence components in your operation.

Benefit:

With this report you can know in detail your use of artificial intelligence components in your operation.

How it works:

  • The consumption of this API is done by GET method.
  • To consume this API you must replace in the url {ip_ipdialbox} by the operation’s server nomenclature and the {token} generated from wolkvox Manager to obtain the information in a secure way.
  • 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.

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

NAME DESCRIPTION TYPE
code Error code. Int
error Name of error. String
msg Explanation of error. String
data Indicates the date in year-month-day-time format. String
nlp type Displays the component used in the record. String
nlp channel Displays the type of channel through which the activity originated.        String
chars send Indicates the number of characters sent. String
chars answer Indicates the number of characters received. String
total chars This is the column that indicates the total number of characters, i.e., the sum of characters sent plus those received. String
date nlp Displays the date on which the record occurred. 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=cdr_7&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: {wolkvox_token}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": " ",
    "error": ,
    "msg": " ",
    "data": [
        {
            "nlp type": " ",
            "nlp channel": " ",
            "chars send": " ",
            "chars answer": " ",
            "total chars": " ",
            "date nlp": " "
        }
    ]
}
				
			
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