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

< / >

APIs Speech Analytics

5. Speech on demand

URL:

http://wv{{server}}.wolkvox.com/api/v2/reports_manager.php?api=speech_5&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This API returns the Text Analytics report when performing the analysis of information from a text type conversation.

Benefit:

You get the writing report and summary of the analyzed text.

How it works:

  • The consumption of this API is done by GET method.
  • The wolkvox-token goes in autorization as API KEY.
  • 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.
  • Validate that the date range is correct.
  • This report contains the same information as the one generated in wolkvox Manager: Reports > Date Range Selection > Speech Analytics > Speech on Demand.
  • 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
date_ini Initial Date String
date_end Final Date String

Response

NAME DESCRIPTION TYPE
code Response code String
error Informs whether there was an error or not. String
msg Reports whether it was successfully consumed or did not receive any text or files String
id_agent Agent extension number String
id_text Conversation identification number String
Text Written conversation String
Summary Summary of the conversation String
Feeling Sentiment identified in the conversation String
Date Date on which the analysis was performed String
num_characters Total number of characters of the written conversation String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://wv{{server}}.wolkvox.com/api/v2/reports_manager.php?api=speech_5&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": " ",
    "error":  ,
    "msg": " ",
    "data": [
        {
            "id_agent": " ",
            "id_text": " ",
            "text": " ",
            "summary": " ",
            "feeling": " ",
            "date": " ",
            "num_characters": " "
        },
    ]
}
				
			
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