FoneNumbers
fonenumbers

Search Local FoneNumbers

Get a list of local FoneNumbers based on search parameters.

get/fonenumbers/inventory/local

Request

  • Base URL: https://api.fonestorm.com/v2
  • URL: https://api.fonestorm.com/v2/fonenumbers/inventory/local
  • Auth: API key in header token

Query parameters

area_codestring

A valid 3-digit area code. Either area_code or search_pattern required.

rate_centerstring

A valid Ratecenter name

statestring

A valid State name

search_option'Starts with' | 'Ends with' | 'Contains'

Allowed values are Starts with, Ends with or Contains

search_patternstring

A valid alphanumeric (a-z,A-Z,0-9) search pattern. Either area_code or search_pattern required.

overlapping_area_codeboolean

Include overlapping area codes in result

include_offnetboolean

Include offnet fonenumbers

maxinteger

Maximum fonenumbers in result

max_tier'X' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'T' | 'Z'

Max tier for FoneNumber

Response

Success

Example response

{
  "fonenumbers": [
    {
      "state": "FL",
      "rate_center": "ORLANDO"
    }
  ]
}

Changes

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