For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
      • POSTCreate SWML Script
      • DELDelete SWML Script
      • GETGet SWML Script
      • GETList SWML Script Addresses
      • GETList SWML Scripts
      • PUTUpdate SWML Script
LogoLogoSignalWire Docs
Log inSign up
Support
Resource ManagementSWML Scripts

List SWML Script Addresses

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts/:id/addresses
GET
/api/fabric/resources/swml_scripts/:id/addresses
$curl https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts/id/addresses \
>     -u "<project_id>:<api_token>"
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}
This endpoints returns a list of addresses associated with a specific SWML script. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

List SWML Scripts

Next
Built with

This endpoints returns a list of addresses associated with a specific SWML script.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

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

Response

The request has succeeded.
datalist of objects
An array of objects that contain a list of SWML Script Addresses
linksobject
Object containing pagination links

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error