List SWML Scripts

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:25:00Z",
11         "swml_script": {
12           "contents": {
13             "sections": {
14               "main": [
15                 {
16                   "play": {
17                     "url": "https://cdn.signalwire.com/swml/audio.mp3"
18                   }
19                 }
20               ]
21             },
22             "version": "1.0.0"
23           },
24           "display_name": "Welcome Script",
25           "id": "993ed018-9e79-4e50-b97b-984bd5534095",
26           "request_url": "https://example.com/swml_script",
27           "script_type": "calling"
28         }
29       }
30     ],
31     "links": {
32       "self": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=0&page_size=50",
33       "first": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=0&page_size=50"
34     }
35   }
36 ]

Returns the project’s SWML Script resources, which store calling or messaging SWML in SignalWire. Use it to discover scripts before retrieving or changing one. Use SWML Webhooks when your server must return SWML for each request, or cXML Scripts for applications written in cXML.

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.

Returns the project's SWML Script resources, which store calling or messaging SWML in SignalWire. Use it to discover scripts before retrieving or changing one. Use [SWML Webhooks](/docs/apis/rest/swml-webhook/list-swml-webhooks) when your server must return SWML for each request, or [cXML Scripts](/docs/apis/rest/cxml-scripts/list-cxml-scripts) for applications written in cXML. #### 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).

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)

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