Load exact numbers from the carrier for one country and number type, optionally narrowed by area code or region. A safe read: nothing is reserved, ordered or charged. A recent identical search is answered from the loaded snapshot or its cooldown instead of reading the carrier again

post/v1/available-numbers/search

Request

  • Base URL: https://api.skysay.ai
  • URL: https://api.skysay.ai/v1/available-numbers/search
  • Auth: none declared

Request body

area_codestring

Only numbers in this area code, for example 212

countrystring required

ISO country code, for example US

limitinteger
number_typestring
regionstring

Only numbers in this state or region, by name or code, for example Texas, TX or US-TX

Response

The rows as GET /v1/available-numbers returns them, the area_code and region searched, refresh_status (succeeded|fresh_cache|cooldown|failed|blocked) and expires_at. Only succeeded and fresh_cache mean the rows are current carrier inventory; cooldown and failed return no rows

Changes

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