Order a number from a region not in the pool

Orders a number from a region outside the listing (Ostrava, Plzeň, Budějovice...). Address codes must come from GET /v1/numbers/address-options. The endpoint waits while we set up an emergency-services address with the carrier and buy the number - usually under a minute; the finished number then comes back in the e164 field with status done. If it doesn't work out on the first try, it returns the order with status pending and a cron job finishes it. The 25.00 CZK fee is only charged once the number is ready.

post/v1/numbers/orders

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/numbers/orders
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional key for one logical request. Its scope is global to this API key, independent of the HTTP method, path, or body: use a new value for every distinct logical action across all endpoints and request bodies, and reuse it only to retry the exact same logical request. Reusing a non-blank key within 24 hours returns the stored response; a concurrent request with the same key returns 409 idempotency_in_progress. A missing or whitespace-only value disables idempotency.

Request body

pscstring required

Premises postal code used to look up the address cascade.

obecstring required

Municipality code returned by GET /v1/numbers/address-options.

cobcestring required

Municipality-part code returned for the selected municipality.

ulicestring

Street code from the address cascade; omit where the address has no street.

cpstring required

House-number code returned by the address cascade, not a free-form address.

Response

Created order

Changes

No recorded changes to this operation across all 1 revision of this API.