Create SWML Script

POST

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

POST

/api/fabric/resources/swml_scripts

$ curl -X POST https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts \
>      -H "Content-Type: application/json" \
>      -u "<project_id>:<api_token>" \
>      -d '{
>   "contents": {
>     "sections": {
>       "main": [
>         {
>           "reply": "Thanks for your message!"
>         }
>       ]
>     },
>     "version": "1.0.0"
>   },
>   "name": "Reply Bot",
>   "script_type": "calling"
> }'

1 {
2   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4   "display_name": "Reply Bot",
5   "type": "swml_script",
6   "created_at": "2024-05-06T12:20:00Z",
7   "updated_at": "2024-05-06T12:25:00Z",
8   "swml_script": {
9     "contents": {
10       "sections": {
11         "main": [
12           {
13             "reply": "Thanks for your message!"
14           }
15         ]
16       },
17       "version": "1.0.0"
18     },
19     "display_name": "Reply Bot",
20     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
21     "request_url": "https://example.com/swml_script",
22     "script_type": "messaging"
23   }
24 }

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.

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

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) ```

Request

This endpoint expects an object.

Create Calling ScriptobjectRequired

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

Create Messaging ScriptobjectRequired

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

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the SWML Script.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the SWML Script Fabric Resource

typeenum

Type of the Fabric Resource

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

swml_scriptobject

SWML Script data.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error