Number Search
You can search for numbers by region, number, prefix, rate center, type, or enabled features.
When performing your search, you'll need to specify the "search type", the options for this are NPA/NXX = 1, Region = 2, Tollfree = 3, Advanced = 4.
The example below shows a generic number search for a Chicago phone number.
curl -X POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "x-api-token: API_TOKEN" \
--header "x-api-user: API_USER" \
--data '{"search_descriptor":{"city":"Chicago","state":"IL"},"search_type":2,"limit":1}' \
"https://api.telnyx.com/origination/number_searches"Note: After pasting the above content, Kindly check and remove any new line added
Sample Response
{
"id": "123-45678-456789",
"result": [
{
"number_vanity": null,
"upfront_cost": "1.00000",
"vanity_string": null,
"monthly_recurring_cost": "1.00000",
"verification_requirements": [],
"regional_data": {
"rate_center": "CHICAGO ZONE 11",
"state": "IL",
"country_iso": "US"
},
"features": [
{
"name": "fax"
},
{
"name": "voice"
},
{
"name": "sms"
}
],
"number_e164": "+17732490576",
"reservable": false,
"currency": "USD",
"best_effort": false
}
],
"inexplicit_result": [],
"search_descriptor": {
"has_all_features": [],
"rc_name": null,
"province": "IL",
"consecutive": null,
"national_destination_codes": null,
"subscriber_number": null,
"vanity_string": null,
"postal_code": null,
"prefix": null,
"trailing_digits": null,
"has_any_features": [],
"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 number-search-payloads.md]
Congrats, you’ve just completed your first number search using the Telnyx API.