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

< / >

APIs

1. ListenVox

URL:

https://wv{{server}}.wolkvox.com/listenVox/listenvox.php

Description:

This API allows you to analyze information (text or audio) from Speech and Text Analytics. It is not necessary that the information entered has been generated by wolkvox applications. But it is required to have wolkvox Manager and Agent.

Benefit:

Analyze call and chat interactions via external consumption without logging into wolkvox applications.

How it works:

  • The consumption of this API is done by POST 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 entered agent exists.
  • It is validated that there is a file loaded.
  • The audio must be in MP3 format, stereo and must not exceed 30 minutes of recording or 1800 seconds.
  • If the transcript exceeds 6800 characters the summary will not be performed.
  • Use the ‘first_to_talk’ parameter to define whether the conversation was initiated by the agent or the cust.
  • The ‘first_to_talk’ parameter is not required.
  • To generate the Text Analytics report (in case of chat or text analysis) go to: Reports > Date Range Selection > Speech Analytics > Speech on Demand.
  • To generate the Speech Analytics report (in case of speech or audio analysis) go to: Reports > Reports > Date range selection > Speech Analytics > Speech on demand: Reports > Date range selection > Speech Analytics > CDR Speech.

REQUEST

NAMEDESCRIPTIONTYPE
agent_idAgent extension number.String
dataText or file (in MP3 format and in stereo system).String
first_to_talkInforms whether the conversation was initiated by the agent or the customer. This parameter is not mandatory.String

RESPONSE

NAMEDESCRIPTIONTYPE
codeResponse code.String
errorInforms whether there was an error or not.String
id_callCaller ID number.String
msgReports whether it was successfully consumed or did not receive any text or file.String

Possible response codes
				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/listenVox/listenvox.php',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('agent_id' => '{{agent_id}}','data'=> new CURLFILE('{{URL_File}}'),'type_call' => '{{type_call}}','cod_act' => '{{cod_act}}'),
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox_token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": " ",
    "error": " ",
    "id": " ",
    "msg": " "
}
				
			
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