Addresses

Read-only access to the project’s Resource Addresses: its alias, SIP, and phone number addresses. Requests authenticate with the project credentials of the RestClient.

Access via client.fabric.addresses on a RestClient instance.

list

List the project’s addresses, newest first. Each item has a type of alias, sip, or phone, and the same fields as the matching alias address, SIP address, or phone number address. Pass type to return one kind only, and page_size, page_number, and page_token to page through results.

get

Retrieve one of the project’s addresses by ID. It returns the same object as the matching item from list.

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
// List all addresses
const addresses = await client.fabric.addresses.list();
for (const addr of addresses.data ?? []) {
    console.log(`${addr['name']}: ${addr['type']}`);
}
// Get a specific address
const address = await client.fabric.addresses.get("address-id");
console.log(`Address: ${address['name']}`);