list_addresses

View as MarkdownOpen in Claude

List addresses associated with a SWML script resource.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the SWML Script.

Response

datalist of objectsRequired
An array of objects that contain a list of SWML Script 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/swml_scripts/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_size=50",
19 "first": "https://example.signalwire.com/api/fabric/resources/swml_scripts/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50",
20 "next": "https://example.signalwire.com/api/fabric/resources/swml_scripts/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=2&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad",
21 "prev": "https://example.signalwire.com/api/fabric/resources/swml_script/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad"
22 }
23}

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
9addresses = client.fabric.swml_scripts.list_addresses("resource-id")
10for addr in addresses.get("data", []):
11 print(f"{addr['display_name']}: {addr['id']}")