fbpx

< / >

APIs Speech Analytics

2. Speech Analytics and VOC

URL

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=speech_on_demand

 

Description

A new API has been implemented in the Speech Analytics API group within Wolkvox Manager. This API enables the activation of voice analysis (Speech Analytics) and customer analysis (VOC) for a specific call using its CONN-ID and Agent_ID. This development facilitates the automation of selected call analysis without manual intervention from the platform, optimizing resource utilization and allowing for the efficient extraction of operational and customer experience insights. It is a requirement that the call must be in stereo, meaning that the agent’s and customer’s audio must be separated into distinct audio channels.

 

Benefits

  • Automation of Analysis: Enables the automated activation of analysis for relevant calls, facilitating the extraction of operational and customer experience insights.
  • Resource Optimization: Allows analysis to be activated only when needed, optimizing resource utilization.
  • Operational Efficiency: Improves efficiency by reducing the need for manual intervention for call analysis.

 

How it works

API Consumption Details

This API is consumed via the GET method.

To use this API, you must replace {{wolkvox_server}} in the URL with your operation’s server nomenclature.

You need to include the header wolkvox-token: {{token}} to use the authorization token.

  • Replace {{date_ini}} with the desired start date and time for your query (format YYYYMMDDHHMMSS, e.g., 20250201000000).
  • Replace {{date_end}} with the desired end date and time for your query (format YYYYMMDDHHMMSS, e.g., 20250228235959).

Please note that the same token cannot be consumed simultaneously. You can schedule the next API call to occur only after the previous one has successfully completed.

For operational monitoring, you can consume information every 5 minutes.

API Limits

  • Download limit per consumption: 60,000 records
  • Upload limit per consumption: 10,000 records
  • Date range limit for queries: 31 days
  • Result weight limit: 256 MB
  • API consumption time limit: 60 seconds
  • Simultaneous token consumption limit: 2 concurrent requests
  • Daily token limit: Number of licenses multiplied by 1000 daily tokens

 

Code Examples

In our Postman workspace (click here to go), you’ll find code examples that simplify integrating with our APIs across various programming languages, including cURL, Python, JavaScript, and more.

This feature is perfect for quick integrations and lets you adapt API calls to your system’s programming language.

 

How to Use the Code Examples

  1. Navigate to our Postman workspace.
  2. Select the API you want to query.
  3. Edit the necessary API parameters to match your goals.
  4. In the “Code” tab, select your preferred language.
  5. You’ll get an auto-generated code snippet, ready to use with the parameters and authentication you’ve already configured.

 

Request

NAMEDESCRIPTIONTYPE
apiRequired report type.String
date_iniStart date (YYYYmmddHHiiss).String
date_endEnd date  (YYYYmmddHHiiss).String
conn_id
Call identification number within the Wolkvox system. 
String
agent_id
Agent identification number within the Wolkvox system linked to the call.
String

Response

NAMEDESCRIPTIONTYPE
code
Response status code. 
String
error
Detailed information about any error that may have occurred during the API execution. 
String
msg
Informative message describing the response. 
String
Possible Response Codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=speech_on_demand',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "conn_id": "",
    "agent_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Speech analytics record created successfully"
}

				
			
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