API Docs
Voxbi Cockpit APIs
All endpoints

Download a Sound File by ID

Returns the sound file download identified by the path parameter. Multi-tenant scoping is enforced: the caller can only fetch resources within their own PBX.

HTTP: PbxServerAuth

Auth for Pbx server

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
soundFileId path · integer *
accept header · string
example: audio/mpeg

Responses

Response schema
No response body.
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
get https://cockpit.voxbi.com/api/v1/sound-files/{soundFileId}/download
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/sound-files/{soundFileId}/download' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/sound-files/{soundFileId}/download', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/sound-files/{soundFileId}/download',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/sound-files/{soundFileId}/download', false, $context);
$data = json_decode($response, true);
print_r($data);
No example for this status.
Host string
example: localhost:8083
Date string
example: Mon, 16 Oct 2023 14:16:41 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: audio/mpeg
Content-Disposition string
example: attachment; filename="soundFile-1.mp3"
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 58
Vary string
example: Origin
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}