Skip to navigation
REST ClientFabric

Addresses

View as MarkdownOpen in Claude

Read-only access to fabric addresses. Addresses represent the endpoints (phone numbers, SIP URIs, domains) that route traffic to fabric resources.

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

list

List all fabric addresses.

Response

items_countintegerRequired
The number of addresses in this page of results.
datalist of objectsRequired
An array of objects containing a list of Resource Addresses

Response Example

Response
{
  "links": {
    "self": "https://example.signalwire.com/api/fabric/addresses?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/addresses?page_number=0&page_size=50",
    "next": "https://example.signalwire.com/api/fabric/addresses?page_number=1&page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://example.signalwire.com/api/fabric/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  },
  "items_count": 1,
  "data": [
    {
      "id": "691af061-cd86-4893-a605-173f47afc4c2",
      "name": "justice-league",
      "display_name": "Justice League",
      "type": "app",
      "cover_url": "https://coverurl.com",
      "preview_url": "https://previewurl.com",
      "locked": true,
      "channels": {
        "audio": "/external/resource_name?channel=audio"
      },
      "canonical_uri": "/public/justice-league",
      "codecs": [
        "OPUS",
        "PCMU"
      ],
      "created_at": "2024-05-06T12:20:00Z"
    }
  ]
}

get

Retrieve a single fabric address.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a FabricAddress.

Response

idstringRequiredformat: "uuid"
Unique ID of the Fabric Address.
namestringRequired
Name of the Fabric Address.
display_namestringRequired
Display name of the Fabric Address.
typeenumRequired
DisplayTypes
Allowed values:
cover_urlstring or nullRequired
Cover URL of the Fabric Address, or `null` when the resource has no cover image.
preview_urlstring or nullRequired
Preview URL of the Fabric Address, or `null` when no preview is available. Only Conference Room addresses return one, while a session with room previews enabled is in progress.
lockedbooleanRequired
Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
channelsobjectRequired
Channels of the Fabric Address.
canonical_uristring or nullRequired
The address in canonical form: `/<context>/<name>` for a resource address, `sip:<domain>` for a SIP address, or the E.164 number for a phone number or WhatsApp number address. `null` when the phone number, WhatsApp number, or SIP domain behind the address no longer exists.
codecslist of enums or nullRequired
Codecs enabled for calls to the address, or `null` when none are set.
created_atdatetimeRequired
Fabric Address Creation Date.

Response Example

Response
{
  "id": "691af061-cd86-4893-a605-173f47afc4c2",
  "name": "justice-league",
  "display_name": "Justice League",
  "type": "app",
  "cover_url": "https://coverurl.com",
  "preview_url": "https://previewurl.com",
  "locked": true,
  "channels": {
    "audio": "/external/resource_name?channel=audio"
  },
  "canonical_uri": "/public/justice-league",
  "codecs": [
    "OPUS",
    "PCMU"
  ],
  "created_at": "2024-05-06T12:20:00Z"
}

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
# List all addresses
addresses = client.fabric.addresses.list()
for addr in addresses.get("data", []):
    print(f"{addr['display_name']}: {addr['type']}")
# Get a specific address
address = client.fabric.addresses.get("address-id")
print(f"Address: {address['display_name']}")