API Docs
Voxbi Cockpit APIs
All endpoints

Get an IVR

Returns the ivr identified by the path parameter. Multi-tenant scoping is enforced: the caller can only fetch resources within their own PBX.

No authentication required
id path · string · uuid *
accept header · string
example: application/json

Responses

Response schema
id*string · uuid
Unique identifier of the IVR menu.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Identifier of the Pbx (tenant) that owns this IVR. All IVRs are scoped to a single tenant.
example: 550e8400-e29b-41d4-a716-446655440001
name*string
Human-readable label for the IVR menu, shown in the admin panel and used to identify the menu in call-flow configuration.
length: 0–128
example: Customer Support Menu
commentstring | null
Optional free-text note describing the purpose or behaviour of this IVR. May be null.
length: 0–255
example: After-hours routing for the support line
announcement_id*string · uuid
Identifier of the SoundFile announcement played to the caller when they enter this IVR menu. The referenced sound file is of type `announcement`.
example: 550e8400-e29b-41d4-a716-446655440002
announcement_languagestring | null
Language override for this IVR's announcement. `null` (Auto) plays the language variant detected/inherited earlier in the call, falling back to the parent announcement. An ISO-639-1 code forces that specific variant.
enum: en de fr lb es it pt nl pl ru tr sv da no fi cs sk el hu ro bg hr uk ar he hi ja ko zh id ms th vi null
example: fr
steps*array<object>
Ordered collection of IVR steps belonging to this menu. Each step maps a caller key press (or the default action) to a routing destination. The array is empty when no steps have been configured yet.
Each item — A single keypad option inside an IVR (Interactive Voice Response) menu. When a caller reaches the parent IVR, the digit they press is matched against `option` (or the `default` step when no digit is pressed before the timeout) and the call is routed to the resource identified by the polymorphic `target_type` plus `target_id` pair. Legal routing targets are call flows and other IVRs, allowing nested menus.
id*string · uuid
Unique identifier of the IVR step.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Identifier of the Pbx (tenant) that owns this IVR step.
example: 550e8400-e29b-41d4-a716-446655440001
ivr_id*string · uuid
Identifier of the parent IVR menu this step belongs to.
example: 550e8400-e29b-41d4-a716-446655440002
target_type*string
Polymorphic morph class of the routing target, stored as the fully qualified PHP class name. Together with `target_id` it identifies where the call is routed when this option is selected. Valid targets are call flows and IVRs.
enum: App\Models\CallFlow App\Models\Ivr
example: App\Models\CallFlow
target_id*string · uuid
Identifier of the routing target resource. The kind of resource is given by `target_type` (a CallFlow or an Ivr).
example: 550e8400-e29b-41d4-a716-446655440003
namestring | null
Optional human-readable label for this step, shown in the admin UI to describe where the option routes. Null when no label has been set.
example: Sales department
option*string
The DTMF key that selects this step. The special value `default` is the fallback applied when the caller does not press any key before the IVR timeout.
enum: default 0 1 2 3 4 5 6 7 8 9 * #
example: 1
languagestring | null
Announcement language override applied from this step onward. `null` (Auto) means the language detected/inherited earlier in the call is kept. ISO-639-1 code otherwise.
enum: en de fr lb es it pt nl pl ru tr sv da no fi cs sk el hu ro bg hr uk ar he hi ja ko zh id ms th vi null
example: fr
voip_ivr_btn_idinteger | null · int32
Legacy integer identifier used to correlate this step with the corresponding button on the VoIP platform side. Null for steps that have no legacy mapping.
example: 42
created_at*string | null · date-time
Timestamp when the IVR step was created.
read-only
example: 2024-03-01T08:29:07Z
updated_at*string | null · date-time
Timestamp when the IVR step was last updated.
read-only
example: 2024-03-01T08:29:07Z
deleted_atstring | null · date-time
Soft-delete timestamp. Null for active steps; set to the deletion time when the step has been soft-deleted.
read-only
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
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.
get https://cockpit.voxbi.com/api/v1/ivrs/{id}
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/ivrs/{id}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/ivrs/{id}', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
});

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

response = requests.get('https://cockpit.voxbi.com/api/v1/ivrs/{id}')
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/ivrs/{id}', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"id": "550e8400-e29b-41d4-a716-446655440000",
"pbx_id": "550e8400-e29b-41d4-a716-446655440001",
"announcement_id": "550e8400-e29b-41d4-a716-446655440002",
"name": "Support IVR",
"comment": "Used for after-hours routing",
"default_action": "repeat",
"voip_ivr_id": 1,
"created_at": "2024-03-01T08:29:07Z",
"updated_at": "2024-03-01T08:29:07Z",
"deleted_at": "2024-03-01T08:29:07Z",
"steps": [ … ]
{ … }
"id": "550e8400-e29b-41d4-a716-446655440000",
"pbx_id": "550e8400-e29b-41d4-a716-446655440001",
"ivr_id": "550e8400-e29b-41d4-a716-446655440002",
"name": "Sales department",
"option": "1",
"target_type": "App\Models\CallFlow",
"target_id": "550e8400-e29b-41d4-a716-446655440003",
"voip_ivr_btn_id": 1,
"created_at": "2024-03-01T08:29:07Z",
"updated_at": "2024-03-01T08:29:07Z",
"deleted_at": "2024-03-01T08:29:07Z"
}
]
}
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Vary string
example: Origin
{ … }
"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
{ … }
"message": "Server Error"
}