Search
Close this search box.

< / >

APIs Information

16. List audios

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=audio_list

Description:

This API allows you to retrieve a list of the audio files stored on the platform, providing detailed information about each file, such as its name, duration, and creation date.

Benefits:

✅ Facilitates the management and querying of audio files within the system.

✅ Allows users to obtain key information about the stored files.

✅ Optimizes the control and organization of audio content.

¿How It Works?

  • The consumption of this API is done via the ‘GET’ method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the server nomenclature of your operation.
  • You must use ‘wolkvox-token: {{token}}’ in the Header to utilize the authorization token.
  • Note that the same token cannot be consumed simultaneously; therefore, you can schedule the next API call to occur only after the previous one has been successful.
  • In terms of timing, you can track your operation by making a request every 5 minutes for the information.

Limits

  • Maximum records that can be downloaded per request: 60,000 records.
  • Maximum records that can be uploaded per request: 10,000 records.
  • Maximum date range for queries: 31 days.
  • Maximum result size: 256 MB.
  • Maximum API consumption time: 60 seconds.
  • Maximum simultaneous consumption of a token: 2 concurrent requests.
  • Daily token limit: Number of licenses multiplied by 1,000 daily tokens.
  • Each audio file cannot exceed 5MB in size.

Code Examples:

In our Postman workspace (click here to access), you will find code examples that facilitate integration with our APIs in various programming languages, such as cURL, Python, JavaScript, and more.

This functionality is ideal for quick integrations and allows you to adapt API calls according to your system’s programming language.

How to Use the Code Examples:

  1. Navigate to our Postman workspace.
  2. Select the API you wish to query.
  3. Edit the necessary API parameters according to your objectives.
  4. In the “Code” tab, select your preferred programming language.
  5. You will receive an autogenerated code snippet, ready to use with the previously configured parameters and authentication.

Request

NAMEDESCRIPTIONTYPE
apiType of report required.String
wolkvox-tokenAccess token.String
wolkvox_serverOperation server.String

Response

NAMEDESCRIPTIONTYPE
codeResponse status code.String
errorError message, if any.String
msgInformational message about the response.String
dataArray of objects containing information about each notification.array
audio_id
Audio identification number.
String
created_at
Date and time when the audio file was created or uploaded to the platform.
String
size
Size of the audio file in kilobytes (KB).
String
duration
Duration of the audio file in seconds.
String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=audio_list',
  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: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "X records were found",
    "data": [
        {
            "audio_id": "",
            "created_at": "",
            "size": "",
            "duration": ""
        },
        {
            "audio_id": "",
            "created_at": "",
            "size": "",
            "duration": ""
        }
    ]
}
				
			
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