GET /users/{user}/twinnings — Voxbi Cockpit APIs

List a user's twinnings (user)

List the twinnings that belong to the given user. Results are paginated.

The following Spatie QueryBuilder filters are supported (exact match): filter[status], filter[phone_number], filter[delay], filter[sync_source] and filter[type]. Sorting is allowed on the same fields; prefix a field with - for descending order, for example sort=-delay.

When a twinning has Fixed-Mobile Convergence (FMC) enabled together with a backup phone number, the response also includes a derived read-only entry for that backup number. The derived entry carries a generated id and is not a separately stored record.

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

page query · integer

Page number to fetch. Defaults to `1`.

per_page query · integer

Number of items per page. Defaults to `25`, maximum `100`.

sort query · string

Field to sort by. Allowed values are `status`, `phone_number`, `delay`, `sync_source` and `type`. Prefix with `-` for descending order.

filter[key] query · string

</br>The filter key can be one of: `status`, `phone_number`, `delay`, `sync_source` or `type` (exact match). </br>The filter value can be any string. </br></br> It is also possible to apply multiple filters using the following format: filter[status]=enabled&filter[type]=mobile

accept header · string

example: application/json

Responses

Response schema

dataarray<object>

Each item — 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

linksobject

firststring

The first page of the resource

example: http://localhost/api/v1/resources?page=1

laststring

The last page of the resource

example: http://localhost/api/v1/resources?page=1

prevnull | string

The previous page of the resource

nextnull | string

The next page of the resource

metaobject

current_pageinteger

The current page of the resource

≥ 1

example: 1

fromnull | integer

The first item of the resource

≥ 1

example: 1

last_pageinteger

The last page of the resource

≥ 1

example: 1

linksarray<object>

urlstring | null

The url of the resource (null for the boundary prev/next links)

example: http://localhost/api/v1/resources?page=1

labelstring

The label of the resource

example: first

activeboolean

The status of the resource

example: 1

pathstring

The path of the resource

example: http://localhost/api/v1/resources

per_pageinteger

The number of items per page of the resource

≥ 1

example: 15

tonull | integer

The last item of the resource

≥ 1

example: 1

totalinteger

The total number of items of the resource

≥ 0

example: 1

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

get https://cockpit.voxbi.com/api/v1/users/{user}/twinnings

Base URL

Request sample

curl -X GET 'https://cockpit.voxbi.com/api/v1/users/{user}/twinnings' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://cockpit.voxbi.com/api/v1/users/{user}/twinnings', {
  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/{user}/twinnings',
    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/{user}/twinnings', false, $context);
$data = json_decode($response, true);
print_r($data);

{ … }

"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"

}

"links": { … },

"first": "https://cockpit.voxbi.com/api/v1/users/550e8400-e29b-41d4-a716-446655440001/twinnings?page=1",

"last": "https://cockpit.voxbi.com/api/v1/users/550e8400-e29b-41d4-a716-446655440001/twinnings?page=1",

"prev": null,

"next": null

"meta": { … }

"current_page": 1,

"from": 1,

"last_page": 1,

"links": [ … ],

{ … }

"url": "https://cockpit.voxbi.com/api/v1/users/550e8400-e29b-41d4-a716-446655440001/twinnings?page=1",

"label": "1",

"active": true

}

"path": "https://cockpit.voxbi.com/api/v1/users/550e8400-e29b-41d4-a716-446655440001/twinnings",

"per_page": 15,

"to": 1,

"total": 1

}

{ … }

"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

No matching endpoints

List a user's twinnings (user)

Responses