WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

COLOMBIA Medellín +57 (4) 322 98 80 Bogotá +57 (1) 381 90 40 Cali +57 (2) 891 28 46 Barranquilla +57 (5) 316 10 34 ARGENTINA Buenos Aires +54 (11) 5217 5933 SPAIN Madrid +34 (910) 601 691 MEXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 UNITED STATES New York +1 (914) 373 71 36 DOMINICAN REPUBLIC Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERU Lima +51 (1) 644 91 39

23. Upload audio

< / >

APIs Configuration

23. Upload audio

URL:

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

Description:

The “Upload Audio” API allows users to upload audio files to wolkvox Manager either in bulk or individually, with a limit of up to 50 audio files per request. These audio files can be used in various sections of wolkvox Manager and in wolkvox Studio components, such as the ‘Play Audio’ component, which plays pre-recorded messages within the configured flows.

Benefits:

✅ Bulk audio upload, reducing the time spent managing sound files in wolkvox Manager.
✅ Facilitates audio customization in different sections of the system, enhancing the user experience.
✅ Greater automation, as it allows integration with other systems to upload audio files programmatically.

With this API, wolkvox users have greater control and efficiency in managing audio files within their operations.

¿How It Works?

The consumption of this API is done via the ‘POST’ method
The body of the API must be of type ‘form-data’.
To consume this API, 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.

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.

Note:

When using the API to upload audio files, files can be handled in two ways depending on the quantity and desired structure:

To upload a single file in each field, use a ‘Key’ with a unique identifier. Example: ‘file1’, ‘file2’, etc.
If you need to upload multiple files in the same field, the ‘Key’ should be defined as an array by adding ‘[]’ at the end. Example: ‘file[]’.

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:

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

Request

NAME	DESCRIPTION	TYPE
wolkvox-token	wolkvox Manager access token.	String
file	“File” type field where you must upload the file to be submitted.	File

Response

NAME	DESCRIPTION	TYPE
code	Response code.	int
error	Error.	String
msg	Response description.	String
data	Array of objects containing information about each notification.	String
filename	Name of the successfully uploaded file.	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=upload_audio',
  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('{{file1}}'=> new CURLFILE('/path/to/file')),
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=upload_audio' \
--header 'wolkvox-token: {{wolkvox-token}}' \
--form '{{file1}}=@"/path/to/file"'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("{{file1}}","/path/to/file",
    RequestBody.create(MediaType.parse("application/octet-stream"),
    new File("/path/to/file")))
  .build();
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=upload_audio")
  .method("POST", body)
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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

payload = {}
files=[
  ('{{file1}}',('file',open('/path/to/file','rb'),'application/octet-stream'))
]
headers = {
  'wolkvox-token': '{{wolkvox-token}}'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

RESPONSE

				
					{
    "code": "201",
    "error": null,
    "msg": "X audio file(s) uploaded successfully",
    "data": [
        {
            "filename": "filename.extension"
        }
    ]
}

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs Configuration

23. Upload audio

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

AUTOMATION AND
ARTIFICIAL INTELLIGENCE

AUTOMATION AND
ARTIFICIAL INTELLIGENCE