Advanced Number Search

This guide will cover everything you need to know about performing advanced number searches.

When performing your search, * matches any character; TELE matches "8353"; && matches "11", "22", etc. You can also use consecutive to search for numbers in sequence e.g. xxx-xxx-1234, xxx-xxx-1235.

To show all available filters, see the full documentation [here]

Copy
Copied
curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "x-api-token: YOUR_API_TOKEN" \
  --data '{"search_descriptor":{"consecutive":4,"city":"Chicago","state":"IL","has_any_features":["sms","voice"]},"search_type":4,"limit":1}' \
  "https://api.telnyx.com/origination/number_searches"

Note: After pasting the above content, Kindly check and remove any new line added

Note: Sample result can vary depending on the available numbers at a given moment.

Copy
Copied
{
  "id": "123-45678-5678",
  "result": [
    {
      "number_vanity": null,
      "upfront_cost": "1.00000",
      "vanity_string": null,
      "monthly_recurring_cost": "1.00000",
      "verification_requirements": [],
      "regional_data": {
        "rate_center": "CHICAGO HEIGHTS",
        "state": "IL",
        "country_iso": "US"
      },
      "features": [
        {
          "name": "fax"
        },
        {
          "name": "voice"
        },
        {
          "name": "sms"
        }
      ],
      "number_e164": "+15558520334",
      "reservable": false,
      "currency": "USD",
      "best_effort": false
    }
  ],
  "inexplicit_result": [],
  "search_descriptor": {
    "has_all_features": [],
    "rc_name": null,
    "province": "IL",
    "consecutive": 4,
    "national_destination_codes": null,
    "subscriber_number": null,
    "vanity_string": null,
    "postal_code": null,
    "prefix": null,
    "trailing_digits": null,
    "has_any_features": [
      "sms",
      "voice"
    ],
    "user_source": "api",
    "national_destination_code": null,
    "city": "Chicago",
    "placement": null,
    "country_iso": "US",
    "reservable": false,
    "best_effort": true
  },
  "status": 2,
  "limit": 1
}

Note: After pasting the above content, Kindly check and remove any new line added

[include advanced-number-search-payloads.md]