API Docs
Voxbi Cockpit APIs
All endpoints

Edit and retry a failed phone number order

Edit selected fields of a submission_failed order and re-submit it upstream. Same multipart contract as POST /numbers/orders.

Uses POST (not PUT) on purpose: the body is multipart/form-data, and many server runtimes only parse a multipart body when the method is POST - on PUT the fields and files arrive empty. Send this edit as a plain POST.

Constraints:

  • Only orders with status submission_failed can be edited.
  • country is frozen. You may re-send it with the same value (handy when you echo back the whole order), but changing it returns 422 - order in a different country by creating a new order. Omitting it is also fine.

customer_name and order_id are editable here: send new values to change them, or send an empty order_id to clear your reference.

If the edited address yields different KYC requirements upstream, the response will be 422 carrying the new requirements; resubmit again with the matching KYC fields.

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
id path · string · uuid *

Request body · required

Request schema
No request body schema.

Responses

Order re-submitted upstream successfully.
Response schema
idstring · uuid
Internal order id assigned by us. Use this with `GET /numbers/orders/{id}` to fetch the latest state. NOT the value echoed in the asynchronous webhook payload - that one is `order_id` (your own reference).
example: 550e8400-e29b-41d4-a716-446655440000
order_idstring | null
Your customer reference, supplied via the `order_id` field in `POST /numbers/orders` (or `POST /numbers/orders/{id}`). Echoed back here, in `GET /numbers/orders/{id}`, and at the top level of the asynchronous webhook payload (which is this same object) as `order_id`.
length: 0–64
example: po-2026-00042
customer_namestring
Legal name of the customer the numbers were ordered for, as supplied on create (and editable on retry).
example: ACME GmbH
statusstring
Lifecycle state of this order. * `requested`: sent upstream, awaiting fulfilment. * `submission_failed`: rejected during synchronous submission; editable + retryable. * `processing`: async success callback received; provisioning in progress. * `success`: provisioning complete; `numbers` is populated. * `error`: async rejection; terminal. * `processing_failed`: internal processing exhausted retries; admin-only retry.
enum: created requested submission_failed processing success error processing_failed
example: requested
addressobject
streetstring
example: Adenauerallee
street_numberstring
example: 1
postal_codestring
example: 53113
citystring
example: Bonn
area_codestring | null
Country-conditional (e.g. set for CH); null otherwise.
countrystring
example: DE
formatted_addressstring | null
Single-line, comma-separated address derived from the persisted components (street + number, postal code + city, country). Empty components are dropped.
example: Adenauerallee 1, 53113 Bonn, DE
quantityinteger
example: 1
prefixstring | null
Dial prefix in E.164 (country + area code if applicable).
example: +49228
numbersarray<string>
E.164-formatted numbers assigned to this order. Empty (`[]`) until the order reaches `success` - they are never returned synchronously by `POST /numbers/orders` (which only ever returns `requested`); they arrive later via the webhook and then appear here on `GET /numbers/orders/{id}`.
[]string
phone_numbersarray<object>
The assigned numbers, in the same shape as `GET /numbers` (id, number, name, is_active, call_flow), so you can read each number's id and current call flow and act on it directly (e.g. `PUT /numbers/{id}/call-flow`). Populated once the order reaches `success`.
idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440000
numberstring
Phone number in E.164 format.
example: +12125550100
namestring | null
example: Customer Support
is_activeboolean
example: 1
call_flow_idstring | null · uuid
example: 550e8400-e29b-41d4-a716-446655440100
call_flowobject | null
idstring · uuid
namestring
enabledboolean
error_messagestring | null
Short error reason when status is `error` or `submission_failed`.
webhook_urlstring | null
The webhook URL we will POST the final outcome to.
webhook_statusstring
enum: not_required pending retrying delivered failed cancelled
webhook_next_retry_atstring | null · date-time
created_atstring · date-time
updated_atstring · date-time
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
The order was created from a different source (e.g. the Cockpit UI) and cannot be retried via the API. Not field-specific, so the body is just a `message`.
Response schema
message*string
Order not found in the caller's PBX.
Response schema
No response body.
The order is not in `submission_failed` state, so it cannot be edited or retried. Not field-specific, so the body is just a `message` (the current status is included in it).
Response schema
message*string
Validation failed. `errors` maps each rejected field to its messages (including an attempt to *change* the locked `country`). If the carrier rejected the retried order, it stays as a retryable `submission_failed` order and is returned in `data` (the full order, same shape as `GET /numbers/orders/{id}`); use `data.id` to edit + retry it via `POST /numbers/orders/{id}`. When `data` is absent, the failure was local validation only.
Response schema
message*string
errors*object
Free-form object
dataobject
Present only for a carrier rejection (a retryable order was persisted). The full order - same shape as `GET /numbers/orders/{id}` - whose `id` you pass to `POST /numbers/orders/{id}` to edit + retry. Absent for local validation errors.
post https://cockpit.voxbi.com/api/v1/numbers/orders/{id}
Base URL
Request sample 
curl -X POST 'https://cockpit.voxbi.com/api/v1/numbers/orders/{id}' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/numbers/orders/{id}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

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

response = requests.post('https://cockpit.voxbi.com/api/v1/numbers/orders/{id}',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
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",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/numbers/orders/{id}', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
No request example provided.
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
{ … }
"message": "This order was not created via the API; retries must be initiated from the Cockpit UI."
}
No example for this status.
{ … }
"message": "Only orders with status submission_failed can be edited and retried (current status: requested)."
}
{ … }
"message": "The street field is required. (and 4 more errors)",
"errors": { … }
"customer_name": [ … ],
"The customer name field is required."
],
"street": [ … ],
"The street field is required."
],
"street_number": [ … ],
"The street number field is required."
],
"postal_code": [ … ],
"The postal code field is required."
],
"city": [ … ],
"The city field is required."
],
"area_code": [ … ],
"The area code field is required."
],
"quantity": [ … ],
"The quantity field must be at least 1."
],
"country": [ … ],
"Country cannot be changed - create a new request if you need to order in a different country."
],
"order_id": [ … ]
"The order id field must not be greater than 64 characters."
]
}
}