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.
regionstring · enumrequiredRegion 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.
carrierstringWhich 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.
patternstringDigits or prefix to match within the number.
pageintegerPage of results to return.
limitintegerResults per page.
user_idintegerReseller 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'
{ "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 }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
region*stringRegion 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.
"IN""US"carrier?stringWhich 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?stringDigits or prefix to match within the number.
page?integerPage of results to return.
1 <= value1limit?integerResults per page.
1 <= value <= 15020user_id?integerReseller accounts only: the client to act on. Omit it to act on your own account.
Response body
application/jsonNumbers available in this region.
application/jsonsuccess?booleanregion?string"IN""US"carrier?stringThe carrier these results came from. Pass it to the purchase operation to buy one of them.
carrier_label?stringDisplay name of that carrier.
numbers?total?integerpage?integerlimit?integertotal_pages?integerWas this page helpful?
List phone numbers
Retrieve the phone numbers on your account, whether you bought them from the OmniDimension number shop or imported your own.
Purchase a phone number
Buy a phone number from the OmniDimension number shop. The monthly rental comes out of your wallet and the number is added to your account, ready to attach to an agent.
