API Docs
Voxbi Cockpit APIs
All endpoints

List images for a model

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

No authentication required
modelType path · string *
The model type (e.g. user, contact)
modelId path · string · uuid *
The model UUID
accept header · string
example: application/json

Responses

Response schema
imagesobject
Images keyed by type then by usage
Free-form object
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/images/{modelType}/{modelId}
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/images/{modelType}/{modelId}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/images/{modelType}/{modelId}', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
});

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

response = requests.get('https://cockpit.voxbi.com/api/v1/images/{modelType}/{modelId}')
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/images/{modelType}/{modelId}', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"images": { … }
"voxbi_desktop": { … }
"logo_main": { … }
"id": 12,
"filename": "voxbi-logo.png",
"mime_type": "image/png",
"size": 8421,
"width": 256,
"height": 64,
"url": "https://cockpit.voxbi.com/api/v1/images/user/550e8400-e29b-41d4-a716-446655440000/logo_main?type=voxbi_desktop"
}
}
}
}
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
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"
}