REST ClientFabricRELAY Applications

listAddresses

View as MarkdownOpen in Claude

List addresses associated with a RELAY application resource.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the Relay Application.

Response

datalist of objectsRequired
An array of objects that contain a list of Relay Application 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/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
19    "first": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
20    "next": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application",
21    "prev": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application"
22  }
23}

Example

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 addresses = await client.fabric.relayApplications.listAddresses("resource-id");
10for (const addr of addresses.data ?? []) {
11  console.log(`${addr.display_name}: ${addr.id}`);
12}