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 Scripts

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts
GET
/api/fabric/resources/swml_scripts
$curl https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts \
>     -u "<project_id>:<api_token>"
1[
2  {
3    "data": [
4      {
5        "id": "993ed018-9e79-4e50-b97b-984bd5534095",
6        "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
7        "display_name": "Welcome Script",
8        "type": "swml_script",
9        "created_at": "2024-05-06T12:20:00Z",
10        "updated_at": "2024-05-06T12:20:00Z",
11        "swml_script": {
12          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
13          "display_name": "Booking Assistant",
14          "script_type": "calling",
15          "request_url": "https://example.com/swml_script",
16          "contents": {
17            "version": "1.0.0",
18            "sections": {
19              "main": [
20                {
21                  "denoise": {},
22                  "play": {
23                    "url": "https://cdn.signalwire.com/swml/audio.mp3"
24                  }
25                }
26              ]
27            }
28          },
29          "status_callback_url": "https://website.com/status",
30          "status_callback_method": "POST"
31        }
32      }
33    ],
34    "links": {
35      "self": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=0&page_size=50&type=swml_script",
36      "first": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_size=50&type=swml_script",
37      "next": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=swml_script",
38      "prev": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=swml_script"
39    }
40  }
41]

A list of SWML Scripts

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.

Was this page helpful?
Previous

Update SWML Script

Next
Built with

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)

Response

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

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error