Dedicated Numbers

Purchase a dedicated phone number

Purchase a dedicated phone number for the specified country. Requires an Idempotency-Key header. If the resolved per-user price exceeds max_price_cents, the server returns PRICE_OVER_CAP (409) without touching your wallet - retry with a fresh key or a higher cap.

post/dedicated/numbers

Request

  • Base URL: https://dashboard.voidmob.com/api/v1
  • URL: https://dashboard.voidmob.com/api/v1/dedicated/numbers
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Client-generated unique key to make this request idempotent.

Request body

countrystring required

Lowercase ISO-2 country code (e.g. "de", "us", "ca").

auto_renewboolean

Automatically renew this number at the end of each billing period.

max_price_centsinteger

Optional price ceiling in cents. If the resolved per-user price is above this value the request returns PRICE_OVER_CAP (409) without charging. Defaults to the quoted price - effectively no cap.

webhook_endpoint_idstring

Deliver rental.created to this endpoint instead of the default.

Example request

{
  "country": "de",
  "max_price_cents": 4000
}

Response

Dedicated number purchased successfully.

successtrue required

Example response

{
  "data": {
    "id": "ded_abc123",
    "display_id": "DED1",
    "phone_number": "+4915123456789",
    "country": "de",
    "country_name": "Germany",
    "quoted_price_cents": 3499,
    "charged_price_cents": 3499,
    "next_renewal_price_cents": 3499,
    "payment_due": {
      "amount_cents": 1499
    }
  }
}

Changes

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