API Docs
Voxbi Cockpit APIs
All endpoints

Get a sIP device

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

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
HTTP: IntegrationApiKey

API key created on the Cockpit Integrations page (an "API key" integration). It is a bearer token owned by the customer's PBX and limited to the scopes selected when the key was created (e.g. phone-numbers, push-configuration).

Send it in the Authorization header:

Authorization: Bearer <api_key>

Manage keys (create / reveal / revoke) from Integrations → New integration → API key.

HTTP Authorization Scheme
bearer
id path · string · uuid *
accept header · string
example: application/json

Responses

Response schema
id*string · uuid
SIP device identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
target_typestring | null
Friendly type of the entity the device is assigned to
enum: user extension
example: user
target_idstring | null · uuid
Identifier of the target entity
example: 550e8400-e29b-41d4-a716-446655440003
extension_id_shown_for_internal_callsstring | null · uuid
Extension displayed in the device's caller ID for internal calls
roaming_user_idstring | null · uuid
User currently roamed onto this device
location_idstring | null · uuid
Physical location the device is installed at
example: 550e8400-e29b-41d4-a716-446655440002
parent_sip_device_idstring | null · uuid
Parent device (e.g. a Gigaset base) for handset child devices
name*string
length: 0–128
example: Reception desk phone
descriptionstring | null
length: 0–255
example: Front-desk Yealink T46U
is_enabled*boolean
Whether the device is currently enabled
example: 1
ip_internalstring | null
Last-seen internal IP
example: 192.168.1.42
ip_externalstring | null
Last-seen external IP
example: 203.0.113.10
user_agentstring | null
SIP User-Agent string reported by the device
example: Yealink SIP-T46U 108.86.0.10
macstring | null
MAC address
example: 00:0a:95:9d:68:16
vlan_phoneinteger | null
VLAN id for the phone interface
example: 100
vlan_pcinteger | null
VLAN id for the PC pass-through interface
example: 200
sip_usernamestring | null
SIP authentication username
length: 0–24
example: device_001
alt_usernamestring | null
Alternate SIP username (used for multi-line registrations)
transportstring
SIP transport
enum: udp tcp tls
example: tls
type*string
Device provisioning category
enum: auto manual gigaset trunk
example: auto
allow_roamingboolean
Whether the device accepts roamed-in users
example:
languagestring
Display language for the device
example: en
easy_deploystring | null · date-time
Timestamp until which the device is in easy-deploy mode
notifystring | null · date-time
Timestamp at which a SIP NOTIFY was last requested
allow_default_pbxes_outgoing_phone_numbersboolean
Whether the PBX default outbound numbers are usable from this device
example:
sync_sourcestring
Provisioning origin
enum: manual provision legacy_import
example: provision
custom_provisioningstring | null
Custom provisioning template snippet
last_seenstring | null · date-time
Last time the device registered
example: 2024-03-01T08:29:07Z
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
targetobject
The resolved device owner (a user or an extension); shape varies by `target_type`. Returned only when requested via `?include=target`.
Free-form object
tagsarray<object>
Tags attached to this device. Returned only when requested via `?include=tags`.
Each item — Free-form label that can be attached to users, SIP devices, phone numbers, and other tenant resources for grouping, filtering, and reporting. Tags are scoped to a single Pbx (tenant). Associations to the resources a tag is applied to are held on the relevant pivot tables, not on this schema.
id*string · uuid
Unique tag identifier (UUID), assigned by the server on creation.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Identifier of the Pbx (tenant) that owns this tag. Tags are never shared across tenants.
read-only
example: 550e8400-e29b-41d4-a716-446655440001
name*string
Human-readable label for the tag, shown in dropdowns and used when filtering tagged resources.
length: 0–64
example: VIP Customers
descriptionstring | null
Optional free-text note explaining the purpose of the tag. Null when no description was provided.
length: 0–255
example: Customers with priority routing and dedicated agents.
created_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the tag was created.
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the tag was last modified.
read-only
example: 2024-03-01T08:29:07Z
caller_identitiesarray<object>
Caller identities available to this device. Returned only when requested via `?include=callerIdentities`.
[]object
Free-form object
locationobject
The resolved installation location. Returned only when requested via `?include=location`.
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/sip-devices/{sip_device}
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/sip-devices/{sip_device}' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/sip-devices/{sip_device}', {
  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/sip-devices/{sip_device}',
    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/sip-devices/{sip_device}', false, $context);
$data = json_decode($response, true);
print_r($data);
No example for this status.
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"
}