> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# Create SWML Script

POST https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/swml_scripts
Content-Type: application/json

Creates a resource that stores a calling or messaging SWML document in SignalWire. Use it for versioned instructions that can run without fetching content from your server; choose [Create SWML webhook](/docs/apis/rest/swml-webhook/create-swml-webhook) when your server must generate different SWML for each request, or [Create cXML Script](/docs/apis/rest/cxml-scripts/create-cxml-script) for cXML applications.

#### 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).

Reference: https://signalwire.com/docs/apis/rest/swml-scripts/create-swml-script

## Authentication

- `Authorization` header (basic auth, required) — 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) ```

## Request

### Body (application/json)

This endpoint expects a SwmlScriptCreateRequest.

- `SwmlScriptCreateRequest`

## Response

### 200

The request has succeeded.

- `id` (string, required) — Unique ID of the SWML Script.
- `project_id` (string, required) — Unique ID of the Project.
- `display_name` (string, required) — Display name of the SWML Script Fabric Resource
- `type` (enum, required) — Type of the Fabric Resource
  - Allowed values: `swml_script`
- `created_at` (datetime, required) — Date and time when the resource was created.
- `updated_at` (datetime, required) — Date and time when the resource was updated.
- `swml_script` (SwmlScript, required) — SWML Script data.

## Errors

### 401 Unauthorized Error

Access is unauthorized.

- `error` (enum, required)
  - Allowed values: `Unauthorized`

### 404 Not Found Error

The server cannot find the requested resource.

- `error` (enum, required)
  - Allowed values: `Not Found`

### 422 Unprocessable Entity Error

The request contains invalid parameters. See errors for details.

- `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors.

### 500 Internal Server Error

An internal server error occurred.

- `error` (enum, required)
  - Allowed values: `Internal Server Error`

## Types

### CallingSwmlScriptCreateRequest

Request body to create a SWML Script that handles inbound or outbound calls.

- `name` (string, required) — Display name of the SWML Script
- `contents` (CallingSwmlScriptCreateRequestContents, required) — The calling SWML document. Uses [calling SWML methods](/docs/swml/reference/calling).
- `script_type` (enum, optional, default: calling) — Set to `calling` for a Calling Script. This is the default when `script_type` is omitted.
  - Allowed values: `calling`
- `status_callback_url` (string, optional) — URL that receives status callbacks for messages sent or calls made by this script.

### MessagingSwmlScriptCreateRequest

Request body to create a SWML Script that handles inbound SMS or MMS messages.

- `name` (string, required) — Display name of the SWML Script
- `contents` (MessagingSwmlScriptCreateRequestContents, required) — The messaging SWML document. Uses [messaging SWML methods](/docs/swml/reference/messaging).
- `script_type` (enum, optional) — Set to `messaging` to create a Messaging Script. If omitted, the API defaults to `calling`, so this field must be set explicitly for messaging scripts.
  - Allowed values: `messaging`

### SwmlScript

A SWML Script — either a [Calling Script](#schema/CallingSwmlScript) for inbound or outbound calls, or a [Messaging Script](#schema/MessagingSwmlScript) for inbound SMS or MMS messages. The `script_type` field on each script (`"calling"` or `"messaging"`) identifies which kind it is.

### Types.StatusCodes.RestApiErrorItem

Details about a specific error.

- `type` (string, required) — The category of error.
- `code` (string, required) — A specific error code.
- `message` (string, required) — A description of what caused the error.
- `url` (string, required) — A link to documentation about this error.
- `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable.

### CallingSwmlScriptCreateRequestContents

The calling SWML document. Uses [calling SWML methods](/docs/swml/reference/calling).

### MessagingSwmlScriptCreateRequestContents

The messaging SWML document. Uses [messaging SWML methods](/docs/swml/reference/messaging).

### CallingSwmlScript

A SWML Script that handles inbound or outbound calls. The `contents` field carries a [calling SWML document](/docs/swml/reference/calling).

- `id` (string, required) — Unique ID of a SWML Script.
- `display_name` (string, required) — The displayed name of the SWML script.
- `script_type` (enum, required) — Set to `calling` for SWML Scripts that handle inbound or outbound calls.
  - Allowed values: `calling`
- `request_url` (string, required) — URL where this SWML Script is hosted.
- `contents` (CallingSwmlScriptContents, required) — The calling SWML document executed when this script runs. Uses [calling SWML methods](/docs/swml/reference/calling).
- `status_callback_url` (string, optional) — URL that receives status callbacks for messages sent or calls made by this script.
- `status_callback_method` (enum, optional) — HTTP method used for status callbacks.
  - Allowed values: `POST`

### MessagingSwmlScript

A SWML Script that handles inbound SMS or MMS messages. The `contents` field carries a [messaging SWML document](/docs/swml/reference/messaging).

- `id` (string, required) — Unique ID of a SWML Script.
- `display_name` (string, required) — The displayed name of the SWML script.
- `script_type` (enum, required) — Set to `messaging` for SWML Scripts that handle inbound SMS or MMS messages.
  - Allowed values: `messaging`
- `request_url` (string, required) — URL where this SWML Script is hosted.
- `contents` (MessagingSwmlScriptContents, required) — The messaging SWML document executed when this script runs. Uses [messaging SWML methods](/docs/swml/reference/messaging).

### CallingSwmlScriptContents

The calling SWML document executed when this script runs. Uses [calling SWML methods](/docs/swml/reference/calling).

### MessagingSwmlScriptContents

The messaging SWML document executed when this script runs. Uses [messaging SWML methods](/docs/swml/reference/messaging).

## Examples

### Simple messaging script

**Request**

```json
{
  "contents": {
    "sections": {
      "main": [
        {
          "reply": "Thanks for your message!"
        }
      ]
    },
    "version": "1.0.0"
  },
  "name": "Reply Bot",
  "script_type": "calling"
}
```

**Response**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reply Bot",
  "type": "swml_script",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:25:00Z",
  "swml_script": {
    "contents": {
      "sections": {
        "main": [
          {
            "reply": "Thanks for your message!"
          }
        ]
      },
      "version": "1.0.0"
    },
    "display_name": "Reply Bot",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "request_url": "https://example.com/swml_script",
    "script_type": "messaging"
  }
}
```

**SDK Code**

```python Simple messaging script
import requests

url = "https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts"

payload = {
    "contents": {
        "sections": { "main": [{ "reply": "Thanks for your message!" }] },
        "version": "1.0.0"
    },
    "name": "Reply Bot",
    "script_type": "calling"
}
headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<project_id>", "<api_token>"))

print(response.json())
```

```javascript Simple messaging script
const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts';
const credentials = btoa("<project_id>:<api_token>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"contents":{"sections":{"main":[{"reply":"Thanks for your message!"}]},"version":"1.0.0"},"name":"Reply Bot","script_type":"calling"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Simple messaging script
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts"

	payload := strings.NewReader("{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"reply\": \"Thanks for your message!\"\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Reply Bot\",\n  \"script_type\": \"calling\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.SetBasicAuth("<project_id>", "<api_token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Simple messaging script
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<project_id>", "<api_token>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"reply\": \"Thanks for your message!\"\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Reply Bot\",\n  \"script_type\": \"calling\"\n}"

response = http.request(request)
puts response.read_body
```

```java Simple messaging script
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts")
  .basicAuth("<project_id>", "<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"reply\": \"Thanks for your message!\"\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Reply Bot\",\n  \"script_type\": \"calling\"\n}")
  .asString();
```

```php Simple messaging script
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts', [
  'body' => '{
  "contents": {
    "sections": {
      "main": [
        {
          "reply": "Thanks for your message!"
        }
      ]
    },
    "version": "1.0.0"
  },
  "name": "Reply Bot",
  "script_type": "calling"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<project_id>', '<api_token>'],
]);

echo $response->getBody();
```

```csharp Simple messaging script
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts");
client.Authenticator = new HttpBasicAuthenticator("<project_id>", "<api_token>");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"reply\": \"Thanks for your message!\"\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Reply Bot\",\n  \"script_type\": \"calling\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Simple messaging script
import Foundation

let credentials = Data("<project_id>:<api_token>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [
  "contents": [
    "sections": ["main": [["reply": "Thanks for your message!"]]],
    "version": "1.0.0"
  ],
  "name": "Reply Bot",
  "script_type": "calling"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Simple calling script

**Request**

```json
{
  "contents": {
    "sections": {
      "main": [
        {
          "play": {
            "url": "https://cdn.signalwire.com/swml/audio.mp3"
          }
        }
      ]
    },
    "version": "1.0.0"
  },
  "name": "Welcome Script",
  "script_type": "calling"
}
```

**Response**

```json
{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Welcome Script",
  "type": "swml_script",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:25:00Z",
  "swml_script": {
    "contents": {
      "sections": {
        "main": [
          {
            "play": {
              "url": "https://cdn.signalwire.com/swml/audio.mp3"
            }
          }
        ]
      },
      "version": "1.0.0"
    },
    "display_name": "Welcome Script",
    "id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "request_url": "https://example.com/swml_script",
    "script_type": "calling"
  }
}
```

**SDK Code**

```python Simple calling script
import requests

url = "https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts"

payload = {
    "contents": {
        "sections": { "main": [{ "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" } }] },
        "version": "1.0.0"
    },
    "name": "Welcome Script",
    "script_type": "calling"
}
headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<project_id>", "<api_token>"))

print(response.json())
```

```javascript Simple calling script
const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts';
const credentials = btoa("<project_id>:<api_token>");

const options = {
  method: 'POST',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"contents":{"sections":{"main":[{"play":{"url":"https://cdn.signalwire.com/swml/audio.mp3"}}]},"version":"1.0.0"},"name":"Welcome Script","script_type":"calling"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Simple calling script
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts"

	payload := strings.NewReader("{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"play\": {\n            \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n          }\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Welcome Script\",\n  \"script_type\": \"calling\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.SetBasicAuth("<project_id>", "<api_token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Simple calling script
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request.basic_auth("<project_id>", "<api_token>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"play\": {\n            \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n          }\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Welcome Script\",\n  \"script_type\": \"calling\"\n}"

response = http.request(request)
puts response.read_body
```

```java Simple calling script
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts")
  .basicAuth("<project_id>", "<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"play\": {\n            \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n          }\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Welcome Script\",\n  \"script_type\": \"calling\"\n}")
  .asString();
```

```php Simple calling script
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts', [
  'body' => '{
  "contents": {
    "sections": {
      "main": [
        {
          "play": {
            "url": "https://cdn.signalwire.com/swml/audio.mp3"
          }
        }
      ]
    },
    "version": "1.0.0"
  },
  "name": "Welcome Script",
  "script_type": "calling"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<project_id>', '<api_token>'],
]);

echo $response->getBody();
```

```csharp Simple calling script
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts");
client.Authenticator = new HttpBasicAuthenticator("<project_id>", "<api_token>");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"contents\": {\n    \"sections\": {\n      \"main\": [\n        {\n          \"play\": {\n            \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\"\n          }\n        }\n      ]\n    },\n    \"version\": \"1.0.0\"\n  },\n  \"name\": \"Welcome Script\",\n  \"script_type\": \"calling\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Simple calling script
import Foundation

let credentials = Data("<project_id>:<api_token>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [
  "contents": [
    "sections": ["main": [["play": ["url": "https://cdn.signalwire.com/swml/audio.mp3"]]]],
    "version": "1.0.0"
  ],
  "name": "Welcome Script",
  "script_type": "calling"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```