API Docs
Voxbi Cockpit APIs
All endpoints

Create a twinning for a user (user)

Create a twinning for the given user. The user_id is taken from the path and the sync_source is always set to manual server-side; neither may be supplied in the request body.

Whether phone_number is required depends on the combination of type and dial_strategy (for example, a voip_only mobile twinning does not require a phone number). A user may hold at most one teams-type twinning and at most one voip_only twinning. backup_phone_number is only accepted when fmc_enabled is true and the twinning is FMC-eligible (mobile type).

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>
user path · string · uuid *
User identifier
accept header · string
example: application/json

Request body · required

Request schema
status*string
Whether the twinning is active.
enum: enabled disabled
example: enabled
phone_numberstring
Twinned destination phone number (E.164 preferred). Required for strategies that dial a number; ignored for Teams or VoIP-only configurations.
length: 0–24
example: +12125550100
delay*integer
Seconds to wait before the twinning leg starts ringing.
≥ 0
example: 5
type*string
Channel used to reach the twinned destination.
enum: mobile teams
example: mobile
dial_strategy*string
How the mobile leg is dialed.
enum: gsm_only voip_only voip_and_gsm_fallback
example: voip_and_gsm_fallback
fmc_enabledboolean
Whether Fixed-Mobile Convergence is enabled.
example:
backup_phone_numberstring | null
Backup number used when the primary FMC leg fails. Requires fmc_enabled.
length: 0–24

Responses

Response schema
dataobject
Twinning: an external destination that rings alongside a user's extension (a mobile phone or a Microsoft Teams endpoint). When a call reaches the user, the twinned destination rings in parallel so the call can be answered away from the desk phone. Tenant scoping is derived from the attached user; this resource has no direct `pbx_id` column of its own.
id*string · uuid
Unique identifier of the twinning.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
user_id*string · uuid
Identifier of the user this twinning belongs to. The user also determines the PBX tenant this twinning is scoped to.
example: 550e8400-e29b-41d4-a716-446655440001
status*string
Whether the twinning is active. Only an enabled twinning rings alongside the user's extension.
enum: enabled disabled
example: enabled
phone_number*string | null
The twinned destination phone number, stored in E.164 format. Null when the twinning targets a Teams endpoint or has no number configured.
example: +12125550100
delay*integer · int32
Number of seconds to wait after the call starts before the twinning leg begins ringing. A value of 0 means it rings immediately.
≥ 0
example: 5
sync_source*string
Origin of this twinning record. `manual` was created by a user, `provision` came from an automated provisioning step, and `legacy_import` was migrated from a previous system.
enum: manual provision legacy_import
example: manual
type*string
Channel used to reach the twinned destination, either a mobile phone or a Microsoft Teams endpoint.
enum: mobile teams
example: mobile
dial_strategy*string
How the mobile leg is dialed: `gsm_only` uses the cellular network only, `voip_only` uses the VoIP app only, and `voip_and_gsm_fallback` tries VoIP first and falls back to GSM. Only meaningful for mobile-type twinnings that use the Fixed-Mobile Convergence (FMC) integration.
enum: gsm_only voip_only voip_and_gsm_fallback
example: voip_and_gsm_fallback
fmc_enabled*boolean
Whether Fixed-Mobile Convergence (FMC) is enabled for this twinning, allowing seamless handover between VoIP and the cellular network.
example:
backup_phone_number*string | null
Secondary phone number, in E.164 format, dialed when the primary FMC leg cannot be reached. Null when no backup is configured.
example: +12125550101
created_atstring | null · date-time
Timestamp when the twinning was created (ISO 8601, UTC).
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp when the twinning was last updated (ISO 8601, UTC).
read-only
example: 2024-03-01T08:29:07Z
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
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
post https://cockpit.voxbi.com/api/v1/users/{user}/twinnings
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/users/{user}/twinnings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"status":"enabled","phone_number":"+12125550100","delay":5,"type":"mobile","dial_strategy":"voip_and_gsm_fallback","fmc_enabled":false,"backup_phone_number":null}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/users/{user}/twinnings', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "status": "enabled",
    "phone_number": "+12125550100",
    "delay": 5,
    "type": "mobile",
    "dial_strategy": "voip_and_gsm_fallback",
    "fmc_enabled": false,
    "backup_phone_number": null
}),
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/users/{user}/twinnings',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "status": "enabled",
    "phone_number": "+12125550100",
    "delay": 5,
    "type": "mobile",
    "dial_strategy": "voip_and_gsm_fallback",
    "fmc_enabled": false,
    "backup_phone_number": null
}
)
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",
        'content' => '{
    \"status\": \"enabled\",
    \"phone_number\": \"+12125550100\",
    \"delay\": 5,
    \"type\": \"mobile\",
    \"dial_strategy\": \"voip_and_gsm_fallback\",
    \"fmc_enabled\": false,
    \"backup_phone_number\": null
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/users/{user}/twinnings', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"status": "enabled",
"phone_number": "+12125550100",
"delay": 5,
"type": "mobile",
"dial_strategy": "voip_and_gsm_fallback",
"fmc_enabled": false,
"backup_phone_number": null
}
{ … }
"data": { … }
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"status": "enabled",
"phone_number": "+12125550100",
"delay": 5,
"sync_source": "manual",
"type": "mobile",
"dial_strategy": "voip_and_gsm_fallback",
"fmc_enabled": false,
"backup_phone_number": null,
"created_at": "2024-03-01T08:29:07Z",
"updated_at": "2024-03-01T08:29:07Z"
}
}
{ … }
"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
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
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