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
  • Methods
  • Phone Number CRUD
  • Import
  • Available Numbers
REST ClientCompat

Phone Numbers

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

delete

Next
Built with

Manage incoming phone numbers with CRUD operations, search available inventory by country, and import external numbers.

Access via client.compat.phoneNumbers on a RestClient instance.

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});
8
9const numbers = await client.compat.phoneNumbers.list();

Methods

Phone Number CRUD

list

List incoming phone numbers in the account.

purchase

Purchase a new phone number.

get

Retrieve a single phone number by SID.

update

Update a phone number’s configuration.

delete

Release a phone number.

Import

importNumber

Import an external phone number.

Available Numbers

listAvailableCountries

List countries with available phone numbers.

searchLocal

Search for available local numbers in a country.

searchTollFree

Search for available toll-free numbers in a country.