Start new call
Start a new call to a destination from a User or Device
DialBack mode: we dial first the targets and once one of those has answered we dial the destination. This allows the user to select which device will be used to start a new call
When no targets are specified we dial all linked device for the user in DialBack mode.
When the source parameter is defined we dial the source number in dial back mode and ignore all the other targets.
When only one target.sip_devices (and no other targets) is specified we try to start the call via the Phone api if this fails we dial the device
Authenticate using a User account (Pbx.instance_name_User.id (example: pbx20dev_7e6ba1ad-4c3c-43a6-a4b7-8c50e13e730d) is the username and password is sha256 of user.password or user.webrtc_password)
- HTTP Authorization Scheme
basic
Authenticate using a User account (Pbx.instance_name_User.id (example: pbx20dev_7e6ba1ad-4c3c-43a6-a4b7-8c50e13e730d) is the username and password is sha256 of user.password or user.webrtc_password)
Alternative for HTTP Basic Auth password for clients who don't support Headers'
- Parameter name
password- Located in
query
Authenticate using a User account (Pbx.instance_name_User.id (example: pbx20dev_7e6ba1ad-4c3c-43a6-a4b7-8c50e13e730d) is the username and password is sha256 of user.password or user.webrtc_password)
Alternative for HTTP Basic Auth username for clients who don't support Headers'
- Parameter name
username- Located in
query
Request body · required
targetsobject
sip_devicesarray<uuid>
a469de67-b79a-4dea-87d2-9a15858f10cd1 11 11 1Local/905a334f-5bf6-4ebc-85d3-2d5411187f68@C-TW-pbx16dev-00000057;200352203333002017905a334f-5bf6-4ebc-85d3-2d5411187f68ttsarray<object>
welcome_messageHello Worldoptionsobject
Responses
okok1 10035220333000targetsobject
sip_devicesarray<uuid>
a469de67-b79a-4dea-87d2-9a15858f10cd1 11 11 1936a90653194073f7ce14f80b067186f68ab32749e1f1b8840d49bf6cd5c9e75https://{username}.voxbi.cloud/api/{version}/calls/new
https://{username}.voxbi.cloud/api/{version}
curl -X POST 'https://{username}.voxbi.cloud/api/{version}/calls/new' \
-H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://{username}.voxbi.cloud/api/{version}/calls/new', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${YOUR_TOKEN}`,
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.post('https://{username}.voxbi.cloud/api/{version}/calls/new',
headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
'http' => [
'method' => 'POST',
'header' => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
],
]);
$response = file_get_contents('https://{username}.voxbi.cloud/api/{version}/calls/new', false, $context);
$data = json_decode($response, true);
print_r($data);