Skip to main content

Local

  • Updated

# Search for Local AvailablePhoneNumbers Use this endpoint for the [AvailablePhoneNumbers](./index.mdx) method to search for available phone numbers that match your criteria. ## Parameters | Parameter | Description | | :- | :- | | AreaCode Optional | Find numbers in the provided area code. Only available for numbers in US and Canada. | | Beta Optional | Whether or not to specify if a number is a new SignalWire number or not. Possible values are true or false. Default is **true**. | | Contains Optional | Find numbers based off of a pattern. Valid characters are [0-9a-zA-Z]. It is recommended to search for a pattern of at least three numbers for best results. | | ExcludeAllAddressRequired Optional | Whether or not to exclude numbers that require an address anywhere in the world. Possible values are true or false, default is **false**. | | ExcludeForeignAddressRequired Optional | Whether or not to exclude numbers that require a foreign address. Possible values are true or false, default is **false**. | | ExcludeLocalAddressRequired Optional | Whether or not to exclude numbers that require a local address. Possible values are true or false, default is **false**. | | FaxEnabled Optional | Whether or not a number can receive faxes. Possible values are true or false. | | InRegion Optional | Limits search to same region as number. | | MmsEnabled Optional | Whether or not a number can receive MMS messages. Possible values are true or false. | | SmsEnabled Optional | Whether or not a number can receive SMS messages. Possible values are true or false. | | VoiceEnabled Optional | Whether or not a number can receive calls. Possible values are true or false. | ## Examples ### Request: Search for Numbers within Washington State shell curl https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/US/Local.json \ -X GET \ -d InRegion=WA \ -u YourProjectID:YourAuthToken javascript const { RestClient } = require(@signalwire/compatibility-api) const client = RestClient(YourProjectID, YourAuthToken, { signalwireSpaceUrl: example.signalwire.com }) client .availablePhoneNumbers(US) .local.list({ inRegion: WA, }) .then(availablePhoneNumbers => { console.log(availablePhoneNumbers); }); csharp using System; using System.Collections.Generic; using Twilio; using Twilio.Rest.Api.V2010.Account; using Twilio.Rest.Api.V2010.Account.AvailablePhoneNumberCountry; class Program { static void Main(string[] args) { TwilioClient.Init(YourProjectID, YourAuthToken, new Dictionary { [signalwireSpaceUrl] = {SPACE}.signalwire.com }); var localAvailableNumbers = LocalResource.Read(US, inRegion: WA); Console.WriteLine(localAvailableNumbers); } } python from signalwire.rest import Client as signalwire_client client = signalwire_client(YourProjectID, YourAuthToken, signalwire_space_url = example.signalwire.com) numbers = client.available_phone_numbers(US) \ .local \ .list(in_region=WA) print(numbers) ruby require signalwire/sdk @client = Signalwire::REST::Client.new YourProjectID, YourAuthToken, signalwire_space_url: example.signalwire.com @numbers = @client.api.available_phone_numbers(US).local .list(in_region: WA) puts @numbers #### Response

200 OK

json { uri: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local?InRegion=WA, available_phone_numbers: [ { friendly_name: 253-218-6751, phone_number: +12532186751, lata: null, rate_center: AUBURN, latitude: null, longitude: null, region: WA, postal_code: null, iso_country: US, capabilities: { voice: true, SMS: true, MMS: true }, beta: false }, { friendly_name: 253-218-6752, phone_number: +12532186752, lata: null, rate_center: AUBURN, latitude: null, longitude: null, region: WA, postal_code: null, iso_country: US, capabilities: { voice: true, SMS: true, MMS: true }, beta: false } ] } ### Request: Find Local Numbers by Number Pattern Find all local numbers in the United States, with area code 510, that contain the pattern 555. shell curl https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountry}/Local.json \ -X GET \ -d Contains=555 \ -d AreaCode=510 \ -u YourProjectID:YourAuthToken javascript const { RestClient } = require(@signalwire/compatibility-api) const client = RestClient(YourProjectID, YourAuthToken, { signalwireSpaceUrl: example.signalwire.com }) client .availablePhoneNumbers(US) .local.list({ contains: 555, areaCode: 510, }) .then(availablePhoneNumbers => { console.log(availablePhoneNumbers); }); csharp using System; using System.Collections.Generic; using Twilio; using Twilio.Rest.Api.V2010.Account; using Twilio.Rest.Api.V2010.Account.AvailablePhoneNumberCountry; class Program { static void Main(string[] args) { TwilioClient.Init(YourProjectID, YourAuthToken, new Dictionary { [signalwireSpaceUrl] = {SPACE}.signalwire.com }); var localAvailableNumbers = LocalResource.Read(US, contains: 555, areaCode: 510); Console.WriteLine(localAvailableNumbers); } } python from signalwire.rest import Client as signalwire_client client = signalwire_client(YourProjectID, YourAuthToken, signalwire_space_url = example.signalwire.com) numbers = client.available_phone_numbers(US) \ .local \ .list(contains=555, area_code=510) print(numbers) ruby require signalwire/sdk @client = Signalwire::REST::Client.new YourProjectID, YourAuthToken, signalwire_space_url: example.signalwire.com @numbers = @client.api.available_phone_numbers(US).local .list(contains: 555, area_code: 510) puts @numbers