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.

REQUEST

NAMEDESCRIPTIONTYPE
date_iniInitial DateString
date_endFinal DateString

RESPONSE

NAMEDESCRIPTIONTYPE
codeResponse codeString
errorInforms whether there was an error or not.String
msgReports whether it was successfully consumed or did not receive any text or filesString
id_agentAgent extension numberString
id_textConversation identification numberString
TextWritten conversationString
SummarySummary of the conversationString
FeelingSentiment identified in the conversationString
DateDate on which the analysis was performedString
num_charactersTotal number of characters of the written conversationString

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