API Docs
Voxbi Cockpit APIs
All endpoints

Create a call flow

Create a call flow. Only name, description and enabled are accepted; the PBX is taken from the authenticated token. Call flow steps are not part of this request: create them separately against /call-flow-steps once the call flow exists.

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
name*string
Name of the call flow.
length: 0–255
descriptionstring | null
Optional free-form description.
enabledboolean
Whether the call flow is active. Falls back to the model default when omitted.

Responses

Response schema
id*string · uuid
Unique call flow identifier.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Identifier of the Pbx (tenant) that owns this call flow.
example: 550e8400-e29b-41d4-a716-446655440001
name*string
Human-readable label for the call flow, shown in lists and pickers.
example: Main inbound flow
descriptionstring | null
Optional free-text note describing the purpose of the call flow.
example: Routes incoming calls to support, then voicemail.
enabled*boolean
Whether the call flow is active. Disabled flows are not applied to calls.
example: 1
version*integer | null · int32
Version counter for the call flow. Set to 1 when the flow is created and bumped on subsequent saves, allowing integrators to detect changes.
≥ 0
example: 7
created_atstring | null · date-time
Timestamp (ISO 8601) when the call flow was created.
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp (ISO 8601) when the call flow was last updated.
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/call-flows
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/call-flows' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"name":"Main inbound flow","description":"Routes incoming calls to support, then voicemail","enabled":true}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/call-flows', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "name": "Main inbound flow",
    "description": "Routes incoming calls to support, then voicemail",
    "enabled": true
}),
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/call-flows',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "name": "Main inbound flow",
    "description": "Routes incoming calls to support, then voicemail",
    "enabled": true
}
)
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' => '{
    \"name\": \"Main inbound flow\",
    \"description\": \"Routes incoming calls to support, then voicemail\",
    \"enabled\": true
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/call-flows', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"name": "Main inbound flow",
"description": "Routes incoming calls to support, then voicemail",
"enabled": true
}
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"
}