MCP is live.Set upAsk the community
OmniDimension
Phone numbers

Search available phone numbers

Search the OmniDimension number shop for phone numbers available to buy in a region. Price and validity are flat per region, so every result shows the same monthly_rental_usd and validity_days, and that is the exact amount a purchase will charge.

carrier is always required, because carriers do not sell the same numbers. Call without one and the 409 carrier_required response lists that region's carriers with what each one stocks, so an integration discovers a carrier we add later without a release of its own.

The response names the carrier its results came from, and that is the carrier the a purchase has to pass. Verification is per carrier too, so a client must be verified on the carrier it is buying from.

Searching does not reserve anything. A number is claimed only when a purchase starts, so one you saw a moment ago can be gone by the time you buy it.

The carrier table and the flow end to end are in Buy a number over the API.

GET/phone_number/search
Query parameters
regionstring · enumrequired

Region to search in. IN and US both serve numbers. Which regions answer is configuration, so a region with no carrier enabled returns 404 not_available rather than an empty list.

carrierstring

Which carrier's stock to search: carriers in a region do not sell the same numbers. Required where a region has more than one carrier; omitting it there returns 409 carrier_required naming the region's carriers and what each one stocks.

patternstring

Digits or prefix to match within the number.

pageinteger

Page of results to return.

limitinteger

Results per page.

user_idinteger

Reseller accounts only: the client to act on. Omit it to act on your own account.

curl -X GET 'https://omnidim.io/api/v1/phone_number/search?region=IN&carrier=carrier-1&pattern=555&page=1&limit=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{
  "success": true,
  "region": "IN",
  "carrier": "carrier-1",
  "carrier_label": "Carrier 1",
  "numbers": [
    {
      "phone_number": "+918000000001",
      "monthly_rental_usd": 5.06,
      "validity_days": 30,
      "region": "IN",
      "kyc_required": true
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20,
  "total_pages": 1
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Query Parameters

region*string

Region to search in. IN and US both serve numbers. Which regions answer is configuration, so a region with no carrier enabled returns 404 not_available rather than an empty list.

Value in"IN""US"
carrier?string

Which carrier's stock to search: carriers in a region do not sell the same numbers. Required where a region has more than one carrier; omitting it there returns 409 carrier_required naming the region's carriers and what each one stocks.

pattern?string

Digits or prefix to match within the number.

page?integer

Page of results to return.

Range1 <= value
Default1
limit?integer

Results per page.

Range1 <= value <= 150
Default20
user_id?integer

Reseller accounts only: the client to act on. Omit it to act on your own account.

Response body

application/json

Response Body

Numbers available in this region.

application/json
success?boolean
region?string
Value in"IN""US"
carrier?string

The carrier these results came from. Pass it to the purchase operation to buy one of them.

carrier_label?string

Display name of that carrier.

numbers?
total?integer
page?integer
limit?integer
total_pages?integer

Was this page helpful?