For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
        • Applications
        • Calls
        • Conferences
        • Faxes
        • LAML Bins
        • Messages
        • Phone Numbers
          • delete
          • get
          • importNumber
          • list
          • listAvailableCountries
          • purchase
          • searchLocal
          • searchTollFree
          • update
        • Queues
        • Recordings
        • Tokens
        • Transcriptions
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientCompatPhone Numbers

searchTollFree

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

update

Next
Built with

Search for available toll-free phone numbers in a specific country.

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account to retrieve.
IsoCountrystringRequired
The ISO country code of the number.

Query parameters

AreaCodestringOptional
Find numbers in the provided area code. Only available for numbers in US and Canada.
BetabooleanOptional
New numbers on SignalWire are marked as `beta`.
ContainsstringOptional
Find numbers based off of a pattern. Valid characters are `[0-9a-zA-Z]`.
ExcludeAllAddressRequiredbooleanOptional
Accepted for Twilio compatibility but has no effect on the response.
ExcludeForeignAddressRequiredbooleanOptional
Accepted for Twilio compatibility but has no effect on the response.
ExcludeLocalAddressRequiredbooleanOptional
Accepted for Twilio compatibility but has no effect on the response.
FaxEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.
InLocalitystringOptional
Limits search to a city/locality. Requires InRegion to also be set.
InRegionstringOptional
Limits search to same region as number. Must be a two-letter state/province code.
MmsEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.
SmsEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.
VoiceEnabledbooleanOptional
Not supported. Accepted for Twilio API compatibility.

Response

uristringRequired
The URI for the API call.
available_phone_numberslist of objectsRequired
List of available phone numbers.

Response Example

Response
1{
2  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local",
3  "available_phone_numbers": [
4    {
5      "friendly_name": "(253) 218-6751",
6      "phone_number": "+12532186751",
7      "lata": null,
8      "locality": null,
9      "rate_center": "AUBURN",
10      "latitude": null,
11      "longitude": null,
12      "region": "WA",
13      "postal_code": null,
14      "iso_country": "US",
15      "capabilities": {
16        "voice": true,
17        "SMS": true,
18        "MMS": true
19      },
20      "beta": false
21    }
22  ]
23}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8const numbers = await client.compat.phoneNumbers.searchTollFree("US", { Contains: "800" });