Get Voice Quality

Owned by Kiss, Mate
Feb 23, 2024
1 min read

Overview

Retrieves Voice Quality Check results for one or more Call Identifiers (ccdr_id).

The function is available as a HTTP GET or HTTP POST request.

Request

Get Voice Quality HTTP GET sample:

http://hostname/verba/api?action=GetVoiceQuality&token=hvMTp6lGwTfwZVNSu1XxQ99p2c9PtpgT&callIDs=182de753-1427-11e9-8de4-0028f8fd6834,e26f595b-141c-11e9-8de4-0028f8fd6834

Detailed description of the API request elements:

URL parameterParameter example

Description

Requirements
actionaction=GetVoiceQualityName of the HTTP API request.Mandatory
tokentoken=hvMTp6lGwTfwZVNSu1XxQ99p2c9PtpgTUnique identifier for authenticated sessions. After successful authentication, the API sends back a token, which has to be used for each request.Mandatory if authentication is configured for the given API key.
responseTyperesponseType=XML

Defines the format of the response of the API request. The following valid values apply:

  • XML: the response is formatted and structured in XML
  • JSON: the response is formatted and structured in JSON
If the parameter is missing, it defaults to XML.
callIDscallIDs=182de753-1427-11e9-8de4-0028f8fd6834,e26f595b-141c-11e9-8de4-0028f8fd6834Comma separated list of Call Identifiers (ccdr_id).Mandatory

Response

XML based response sample on success:

<?xml version = '1.0' encoding = 'UTF-8'?>
<voice_quality_check_scores>
<conversation>
<callID>182de753-1427-11e9-8de4-0028f8fd6834</callID>
<found>true</found>
<voice_quality>
<item>
<name>Silence</name>
<value>60</value>
</item>
<item>
<name>Unnatural Silence</name>
<value>20</value>
</item>
<item>
<name>Sharp Amplitude Changes</name>
<value>30</value>
</item>
<item>
<name>Waveform Envelope Variance</name>
<value>50</value>
</item>
<item>
<name>Volume</name>
<value>60</value>
</item>
<item>
<name>Noise</name>
<value>10</value>
</item>
<item>
<name>Beeps and Clicks</name>
<value>1</value>
</item>
<item>
<name>RTP Loss</name>
<value>2</value>
</item>
<item>
<name>Decoding Errors</name>
<value>1</value>
</item>
<item>
<name>SRTP Decryption Errors</name>
<value>2</value>
</item>
<item>
<name>Media Mixing Errors</name>
<value>3</value>
</item>
</voice_quality>
</conversation>
<conversation>
<callID>e26f595b-141c-11e9-8de4-0028f8fd6834</callID>
<found>false</found>
</conversation>
</voice_quality_check_scores>

XML based response sample on error:


<?xml version="1.0" encoding="UTF-8"?>
<VerbaApi>
<Response
code="-1"
type="GetVoiceQuality"

>
<ErrorMessage>StatusCodeException: Parameter callIDs is mandatory.
</ErrorMessage>
</Response>
</VerbaApi>