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

URL:

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

Description: This is an API that allows for the generation of speech analytics and the analysis of voicetotext conversion on calls.

Benefit: It allows for the optimization of voicetotext conversion analysis without having to listen to the recordings of the calls.

How it works:

 

REQUEST
NAME DESCRIPTION TYPE
api Required Report Type String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

RESPONSE

RESPONSE
NAME DESCRIPTION TYPE
agent_id This is the numerical user that is assigned to each of the wolkvox Agente users. String
agent_name This is the name that is assigned to each of the wolkvox Agente users. String
agent_dni This is the identification document of each of the wolkvox Agente users. String
conn_id This corresponds to the Id of the call. String
time Indicate time in units of seconds. String
date Indicate the date in the format yearmonthdayhour. String
time_silence Indicates how many seconds of total silence there were in the conversation. When the conversation channel is different from “voice”, it will always show 0 (zero). String
customer_phone It corresponds to the customer‘s phone. String
customer_id It corresponds to the customer‘s identification number. String
cod_act It refers to the call typification. String
description_cod_act Description of the call typification code String
greeting Indicates whether the agent greeted or not. This field displays the values “yes” and “no”. String
slow_to_greet Indicates whether the agent was too slow to greet or not. This field displays the values “yes” and “no”. String
greeting_agent_name Indicates whether the agent said their name along with the greeting. The format is: “yes – name said”; Or simply the value “no” to indicate that the agent did not say their name. String
category# The fields that come after the “greeting_agent_name” field up until just before “audio_text” are the custom categories configured in the “Voice and Text Analysis” section in wolkvox Manager. These custom categories are designed to identify key words and phrases associated with each specific category. This enables intelligent detection of relevant mentions during interactions, whether in voice or text form, providing a detailed and useful analysis for evaluating the effectiveness and quality of the service provided. Up to 10 categories can appear here. String
audio_text Transcription of the call from voice to text. String
feeling Analyzed and identified sentiment in the client. The values this column provides are: very negative, negative, neutral, positive, and very positive. String
channel Contact channel. This column can yield any of the following values: chat-facebook, chat-instagram, chat-sms, chat-web, chat-whatsapp, and voice (to indicate it’s a call). 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=speech_1&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": [
        {
            "agent_id": "",
            "agent_name": "",
            "agent_dni": "",
            "conn_id": "",
            "time": "",
            "customer_id": "",
            "date": "",
            "time_silence": "",
            "customer_phone": "",
            "cod_act": "",
            "description_cod_act": "",
            "greeting": "",
            "slow_to_greet": "",
            "greeting_agent_name": "",
            "audio_text": "",
            "feeling": "",
            "channel": ""
        }
    ]
}

				
			

< / >

APIs Reports Manager

1. CDR Speech En

URL:

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

Description: This is an API that allows for the generation of speech analytics and the analysis of voicetotext conversion on calls.

Benefit: It allows for the optimization of voicetotext conversion analysis without having to listen to the recordings of the calls.

How it works:

  • This API is consumed through the GET method.
  • To consume this API, you must replace in the URL {{wolkvox_server}} with the server nomenclature of the operation.
  • The wolkvoxtoken header must be used to make use of the authorization token.
  • Please note that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.

 

REQUEST
NAME DESCRIPTION TYPE
api Required Report Type String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

RESPONSE
NAME DESCRIPTION TYPE
agent_id This is the numerical user that is assigned to each of the wolkvox Agente users. String
agent_name This is the name that is assigned to each of the wolkvox Agente users. String
agent_dni This is the identification document of each of the wolkvox Agente users. String
conn_id This corresponds to the Id of the call. String
time Indicate time in units of seconds. String
date Indicate the date in the format yearmonthdayhour. String
time_silence Indicates how many seconds of total silence there were in the conversation. When the conversation channel is different from “voice”, it will always show 0 (zero). String
customer_phone It corresponds to the customer‘s phone. String
customer_id It corresponds to the customer‘s identification number. String
cod_act It refers to the call typification. String
description_cod_act Description of the call typification code String
greeting Indicates whether the agent greeted or not. This field displays the values “yes” and “no”. String
slow_to_greet Indicates whether the agent was too slow to greet or not. This field displays the values “yes” and “no”. String
greeting_agent_name Indicates whether the agent said their name along with the greeting. The format is: “yes – name said”; Or simply the value “no” to indicate that the agent did not say their name. String
category# The fields that come after the “greeting_agent_name” field up until just before “audio_text” are the custom categories configured in the “Voice and Text Analysis” section in wolkvox Manager. These custom categories are designed to identify key words and phrases associated with each specific category. This enables intelligent detection of relevant mentions during interactions, whether in voice or text form, providing a detailed and useful analysis for evaluating the effectiveness and quality of the service provided. Up to 10 categories can appear here. String
audio_text Transcription of the call from voice to text. String
feeling Analyzed and identified sentiment in the client. The values this column provides are: very negative, negative, neutral, positive, and very positive. String
channel Contact channel. This column can yield any of the following values: chat-facebook, chat-instagram, chat-sms, chat-web, chat-whatsapp, and voice (to indicate it’s a call). 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=speech_1&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": [
        {
            "agent_id": "",
            "agent_name": "",
            "agent_dni": "",
            "conn_id": "",
            "time": "",
            "customer_id": "",
            "date": "",
            "time_silence": "",
            "customer_phone": "",
            "cod_act": "",
            "description_cod_act": "",
            "greeting": "",
            "slow_to_greet": "",
            "greeting_agent_name": "",
            "audio_text": "",
            "feeling": "",
            "channel": ""
        }
    ]
}

				
			
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