API Docs
Voxbi Cockpit APIs
All endpoints

Create a tag

Create a new tag and optionally attach it to a set of users and SIP devices. The pbx_id is forced from the authenticated user and must not be sent in the request body.

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
accept header · string
example: application/json

Request body · required

Request schema
pbx_id*string · uuid
Pbx identifier (tenant). Must match the authenticated user's PBX.
name*string
Tag name (must be unique within the PBX)
length: 3–64
descriptionstring | null
length: 3–255
usersarray<string>
Identifiers of users to attach this tag to
[]string · uuid
sipDevicesarray<string>
Identifiers of SIP devices to attach this tag to
[]string · uuid

Responses

Response schema
dataobject
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
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
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
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.
post https://cockpit.voxbi.com/api/v1/tags
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/tags' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"pbx_id":"550e8400-e29b-41d4-a716-446655440001","name":"VIP","description":"Customers with priority routing","users":["550e8400-e29b-41d4-a716-446655440010"],"sipDevices":["550e8400-e29b-41d4-a716-446655440020"]}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/tags', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "pbx_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "VIP",
    "description": "Customers with priority routing",
    "users": [
        "550e8400-e29b-41d4-a716-446655440010"
    ],
    "sipDevices": [
        "550e8400-e29b-41d4-a716-446655440020"
    ]
}),
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/tags',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "pbx_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "VIP",
    "description": "Customers with priority routing",
    "users": [
        "550e8400-e29b-41d4-a716-446655440010"
    ],
    "sipDevices": [
        "550e8400-e29b-41d4-a716-446655440020"
    ]
}
)
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' => '{
    \"pbx_id\": \"550e8400-e29b-41d4-a716-446655440001\",
    \"name\": \"VIP\",
    \"description\": \"Customers with priority routing\",
    \"users\": [
        \"550e8400-e29b-41d4-a716-446655440010\"
    ],
    \"sipDevices\": [
        \"550e8400-e29b-41d4-a716-446655440020\"
    ]
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/tags', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"pbx_id": "550e8400-e29b-41d4-a716-446655440001",
"name": "VIP",
"description": "Customers with priority routing",
"users": [ … ],
"550e8400-e29b-41d4-a716-446655440010"
],
"sipDevices": [ … ]
"550e8400-e29b-41d4-a716-446655440020"
]
}
No example for this status.
{ … }
"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
{ … }
"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
{ … }
"message": "Server Error"
}