Skip to navigation
REST ClientFabriccXML Scripts

list_addresses

View as MarkdownOpen in Claude

List addresses associated with a cXML script resource.

Path parameters

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

Response

datalist of objectsRequired
An array of objects that contain a list of cXML Script Addresses

Response Example

Response
{
  "data": [
    {
      "id": "691af061-cd86-4893-a605-173f47afc4c2",
      "resource_id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "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"
      },
      "canonical_uri": "/public/justice-league",
      "type": "app"
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/cxml_scripts/3fa85f64-5717-4562-b3fc-2c963f66afa6/addresses?page_number=0&page_size=50&type=cxml_script",
    "first": "https://example.signalwire.com/api/fabric/resources/cxml_scripts/3fa85f64-5717-4562-b3fc-2c963f66afa6/addresses?page_size=50&type=cxml_script",
    "next": "https://example.signalwire.com/api/fabric/resources/cxml_scripts/3fa85f64-5717-4562-b3fc-2c963f66afa6/addresses?page_number=1&page_size=50&page_token=PA08cdad0c-e7e6-4a75-8244-902524f38d55&type=cxml_script",
    "prev": "https://example.signalwire.com/api/fabric/resources/cxml_scripts/3fa85f64-5717-4562-b3fc-2c963f66afa6/addresses?page_number=0&page_size=50&page_token=PB08cdad0c-e7e6-4a75-8244-902524f38d55&type=cxml_script"
  }
}

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
addresses = client.fabric.cxml_scripts.list_addresses("resource-id")
for addr in addresses.get("data", []):
    print(f"{addr['display_name']}: {addr['id']}")