Skip to navigation
REST ClientFabricSIP Endpoints

listAddresses

View as MarkdownOpen in Claude

List addresses associated with a SIP endpoint resource.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the SIP Endpoint.

Response

datalist of objectsRequired
An array of objects that contain a list of SIP Endpoint Addresses

Response Example

Response
{
  "data": [
    {
      "id": "691af061-cd86-4893-a605-173f47afc4c2",
      "name": "justice-league",
      "display_name": "Justice League",
      "cover_url": "https://coverurl.com",
      "preview_url": "https://previewurl.com",
      "locked": true,
      "channels": {
        "audio": "/external/resource_name?channel=audio"
      },
      "created_at": "2024-05-06T12:20:00Z",
      "type": "call"
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/sip_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_number=0&page_size=50&type=sip_endpoint",
    "first": "https://example.signalwire.com/api/fabric/resources/sip_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_size=50&type=sip_endpoint",
    "next": "https://example.signalwire.com/api/fabric/resources/sip_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=sip_endpoint",
    "prev": "https://example.signalwire.com/api/fabric/resources/sip_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=sip_endpoint"
  }
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
const addresses = await client.fabric.sipEndpoints.listAddresses("endpoint-id");
for (const addr of addresses.data ?? []) {
  console.log(`${addr.display_name}: ${addr.id}`);
}