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

datalist of objectsRequired
An array of objects containing a list of Resource Addresses

Response Example

Response
1{
2  "data": [
3    {
4      "id": "691af061-cd86-4893-a605-173f47afc4c2",
5      "name": "justice-league",
6      "display_name": "Justice League",
7      "cover_url": "https://coverurl.com",
8      "preview_url": "https://previewurl.com",
9      "locked": true,
10      "channels": {
11        "audio": "/external/resource_name?channel=audio"
12      },
13      "created_at": "2024-05-06T12:20:00Z",
14      "type": "app"
15    }
16  ],
17  "links": {
18    "self": "https://example.signalwire.com/api/fabric/addresses?page_number=0&page_size=50",
19    "first": "https://example.signalwire.com/api/fabric/addresses?page_number=0&page_size=50",
20    "next": "https://example.signalwire.com/api/fabric/addresses?page_number=1&page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
21    "prev": "https://example.signalwire.com/api/fabric/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
22  }
23}

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.
cover_urlstringRequired
Cover url of the Fabric Address.
preview_urlstringRequired
Preview url of the Fabric Address.
lockedbooleanRequired
Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
channelsobjectRequired
Channels of the Fabric Address.
created_atdatetimeRequired
Fabric Address Creation Date.
typeenumRequired
DisplayTypes
Allowed values:

Response Example

Response
1{
2  "id": "691af061-cd86-4893-a605-173f47afc4c2",
3  "name": "justice-league",
4  "display_name": "Justice League",
5  "cover_url": "https://coverurl.com",
6  "preview_url": "https://previewurl.com",
7  "locked": true,
8  "channels": {
9    "audio": "/external/resource_name?channel=audio"
10  },
11  "created_at": "2024-05-06T12:20:00Z",
12  "type": "app"
13}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9# List all addresses
10addresses = client.fabric.addresses.list()
11for addr in addresses.get("data", []):
12    print(f"{addr['display_name']}: {addr['type']}")
13
14# Get a specific address
15address = client.fabric.addresses.get("address-id")
16print(f"Address: {address['display_name']}")