GET /call-flow-steps — Voxbi Cockpit APIs

List Call flow step

Returns a paginated list of call flow steps. Use the standard search, sort, page, and perPage query parameters; use filter[key]=value to narrow the result set. Multi-tenant scoping is enforced.

No authentication required

search query · string

Free-text search across the resource's searchable fields.

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. Prefix with `-` for descending order (e.g. `-created_at`).

filter[key] query · string

The filter key can be any of the following keys: id, pbx_id, call_flow_id, type, options, is_active and order. The filter value can be any string or number. You can also apply multiple filters using `filter[key1]=value1&filter[key2]=value2`.

accept header · string

example: application/json

Responses

Response schema

dataarray<object>

[]object

A single step inside a call flow. Steps are evaluated in ascending `order` to drive how an inbound call is handled. The `type` field discriminates the shape of `options`: each variant below documents the keys carried in `options` for that particular step type. Variants with no configurable settings (`hang_up`, `start_recording`, `answer`) use an empty options object. The v1 API returns exactly these top-level fields on every variant: `id`, `pbx_id`, `call_flow_id`, `type`, `options`, `is_active`, `order`. Most ID references inside `options` are UUIDs of related resources (users, groups, IVRs, queues, schedules, etc.) scoped to the same tenant.

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

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.

get https://cockpit.voxbi.com/api/v1/call-flow-steps

Base URL

Request sample

curl -X GET 'https://cockpit.voxbi.com/api/v1/call-flow-steps'

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

{ … }

"data": [ … ],

{ … }

"id": "550e8400-e29b-41d4-a716-446655440000",

"pbx_id": "550e8400-e29b-41d4-a716-446655440001",

"call_flow_id": "550e8400-e29b-41d4-a716-446655440002",

"type": "ring_user",

"options": { … }

"duration": 20,

"also_ring_dialed_extension": false,

"also_ring_everyone_in_the_user_group": false,

"dial_mobile_twinnings": false,

"missed_calls": true,

"music_on_hold": "550e8400-e29b-41d4-a716-446655440000",

"users": [ … ],