REST ClientCompat

Phone Numbers

View as MarkdownOpen in Claude

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.