API Docs
Voxbi Cockpit APIs
All endpoints

Get an user WebRTC configuration by Email

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

API Key: ApiKeyAuth
Parameter name
Authorization
Located in
header
email path · string *
accept header · string
example: application/json

Responses

Response schema
hostnamestring
example: pbx.mixvoip.com
portinteger
example: 8089
usernamestring
example: mixvoip_webrtc_1337
passwordstring
example: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
caller_identitiesarray<object>
idinteger
example: 1
root_phone_nuber_idinteger
example: 1
external_caller_extensionstring
example: 1337
external_caller_numberstring
example: 2033331337
allow_anonymous_callsboolean
example: 1
allow_call_forwardingboolean
example: 1
allow_change_twinning_destboolean
example: 1
allow_dndboolean
example: 1
allow_status_changerboolean
example: 1
call_information_visibilitystring
enum: own_calls own_group_only none
example: own_calls
call_pickpup_restrictionsstring
enum: yes own_groups_only no
example: yes
voicemailboolean
example: 1
voicemail_destinationstring
enum: email_only email_and_phone
example: email_only
voicemail_pinstring
example: 1234
voicemail_typestring
enum: enabled external internal
example: enabled
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/users/{email}/webrtc
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/users/{email}/webrtc' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/users/{email}/webrtc', {
  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/users/{email}/webrtc',
    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/users/{email}/webrtc', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"hostname": "pbx.mixvoip.com",
"port": 8089,
"username": "mixvoip_webrtc_1337",
"password": "$2y$10$ePs3A38yC.ewAqS0CVLghuLvimTIm5Pf0HUw5155wM9wd16XVqpeS",
"caller_identities": [ … ],
{ … }
"id": 1,
"root_phone_nuber_id": 1,
"external_caller_extension": "1337",
"external_caller_number": "2033331337"
}
],
"allow_anonymous_calls": true,
"allow_call_forwarding": true,
"allow_change_twinning_dest": true,
"allow_dnd": true,
"allow_status_changer": true,
"call_information_visibility": "own_calls",
"call_pickpup_restrictions": "yes",
"voicemail": true,
"voicemail_destination": "email_only",
"voicemail_pin": "1234",
"voicemail_type": "enabled"
}
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"
}