Number Search V1

Search by NPANXX:

"nxx" parameter is optional.

{
  "search_descriptor": {
    "npa": "301",
    "nxx": "359"
  }
}

Search by Region:

Search by city and state abbreviation.

{
  "search_descriptor": {
    "city": "Chicago",
    "state": "IL"
  }
}

Search by Country:

Specifying a country and city

{
  "search_descriptor": {
    "city": "Paris",
    "country_iso": "FR"
  }
}

Specifying a country and area code

{
  "search_descriptor": {
    "national_destination_code": "17037",
    "country_iso": "FR"
  }
}

{
  "search_descriptor": {
    "has_all_features": ["voice", "sms", "fax"],
    "national_destination_code": "301",
    "country_iso": "US"
  }
}

Search by Tollfree prefix:

"800", "888", etc...

{
   "search_descriptor":{
      "country_iso":"US",
      "npa":"877"
   },
   "search_type":2
}

Search by multiple Tollfree prefixes:

{
    "search_descriptor": {
        "country_iso": "US",
        "national_destination_codes": ["800", "888"]
    },
    "search_type": 2
}

Search Vanity Tollfree numbers with placement start:

{
    "search_descriptor": {
        "placement": "start",
        "vanity_string": "TELNYX", 
        "national_destination_code": "all", 
        "trailing_digits": 2,
        "country_iso": "US"
},
    "search_type": 2
}

Search Vanity Tollfree numbers with placement any:

{
    "search_descriptor": {
        "placement": "any",
        "vanity_string": "TELNYX", 
        "national_destination_code": "all", 
        "trailing_digits": 2,
        "country_iso": "US"
},
    "search_type": 2
}

Search Vanity Tollfree numbers with placement end:

{
    "search_descriptor": {
        "placement": "end",
        "vanity_string": "TELNYX", 
        "national_destination_code": "all", 
        "trailing_digits": 2,
        "country_iso": "US"
},
    "search_type": 2
}

Search by advanced parameters:

* matches any character; TELE matches "8353"; && matches "11", "22", etc...

Use consecutive to search for numbers in sequence, such as xxx-xxx-1234, xxx-xxx-1235

Advanced NPA/NXX exp:

{
  "search_descriptor": {
    "npa": "8*",
    "nxx": "4&&",
    "fdn": "ABC*",
    "consecutive": 4
  }
}

Advanced REGION exp:

{
  "search_descriptor": {
    "fdn": "ABC*",
    "consecutive": 4,
    "city": "Chicago",
    "state": "IL"
  }
}

Advanced RATE CENTER exp:

{
  "search_descriptor": {
    "fdn": "ABC*",
    "consecutive": null,
    "rc_name": "CHICAGO HEIGHTS",
    "state": "IL"
  }
}

Limiting search results:

To limit the number of search results, use the limit key:

{
  "search_descriptor": {
    "fdn": "ABC*",
    "consecutive": 4,
    "city": "Chicago",
    "state": "IL"
  },
  "limit": 50
}

Feature search:

To limit search results to having certain features. For example, you can choose to search for only SMS enabled numbers by limiting has_all_features to just sms.

{
  "search_type": 2,
  "search_descriptor": {
    "fdn": "ABC*",
    "consecutive": 4,
    "city": "Chicago",
    "state": "IL",
    "has_all_features": ["sms"]
  },
  "limit": 50
}

has_all_features will return numbers that have BOTH sms and voice

{
  "search_type": 2,
  "search_descriptor": {
    "fdn": "ABC*",
    "consecutive": 4,
    "city": "Chicago",
    "state": "IL",
    "has_any_features": ["sms", "voice"]
  },
  "limit": 50
}

has_any_features will return numbers that have either sms or voice

Possible features: sms, mms, voice, fax, emergency

Disabling Best Effort Search:

By default, best_effort is enabled on all searches. To omit best effort results, set the best_effort key to false in your search request:

{
  "search_descriptor": {
    "npa": "312",
    "best_effort": false
  }
}

Retrieves the details of an existing number search. Searches expire 15 minutes after creation. Once expired they can no longer be used to create an order.

Searches may include best effort matches in the results. These are numbers that are close to your search terms, but may not be exact matches. Best effort matches will come after exact matches in the results and can be easily distinguished by the value of best_effort being true.

The top-level key any_best_effort is also an indicator of whether there are best effort matches present in the results."