API Docs
Voxbi Cockpit APIs
All endpoints

Create a forward for a user

Creates a new user user forwards index. Validation rules and required fields are defined in the request body schema below.

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 *
UUID of the user
accept header · string
example: application/json

Request body · required

Request schema
enabled*boolean
Whether this forward rule is active
example: 1
namestring | null
Optional human-readable name used to identify the forward
example: Mobile
event*string
When the forward should trigger
enum: busy no_answer unconditional unreachable
example: no_answer
target*string
Where the forward routes the call
enum: phone_number extension voicemail
example: phone_number
target_optionsobject
Target-type-specific configuration
Free-form object
caller_identity_idstring | null · uuid
Scope the forward to a specific caller identity (null = all)

Responses

Response schema
dataobject
idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440010
user_idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440001
typestring
example: unconditional
destinationstring
example: +32499123456
statusboolean
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.
post https://cockpit.voxbi.com/api/v1/users/{user}/forwards
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/users/{user}/forwards' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"enabled":true,"event":"no_answer","target":"phone_number","target_options":{"phone_number":"+12125550100"},"caller_identity_id":null}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/users/{user}/forwards', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "enabled": true,
    "event": "no_answer",
    "target": "phone_number",
    "target_options": {
        "phone_number": "+12125550100"
    },
    "caller_identity_id": null
}),
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/users/{user}/forwards',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "enabled": true,
    "event": "no_answer",
    "target": "phone_number",
    "target_options": {
        "phone_number": "+12125550100"
    },
    "caller_identity_id": null
}
)
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' => '{
    \"enabled\": true,
    \"event\": \"no_answer\",
    \"target\": \"phone_number\",
    \"target_options\": {
        \"phone_number\": \"+12125550100\"
    },
    \"caller_identity_id\": null
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/users/{user}/forwards', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"enabled": true,
"event": "no_answer",
"target": "phone_number",
"target_options": { … },
"phone_number": "+12125550100"
},
"caller_identity_id": null
}
{ … }
"data": { … }
"id": "550e8400-e29b-41d4-a716-446655440010",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"type": "unconditional",
"destination": "+32499123456",
"status": true
}
}
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
{ … }
"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"
}