Update SWML Script | SignalWire

import requests
url = "https://{your_space_name}.signalwire.com/api/fabric/resources/swml_scripts/id"
payload = {}
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(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:20:00Z",
  "swml_script": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contents": "{ \"version\": \"1.0.0\", \"sections\": { \"main\": [{ \"play\": { \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\" }}]}};",
    "request_url": "https://example.com/swml_script",
    "display_name": "Booking Assistant",
    "status_callback_url": "https://website.com/status",
    "status_callback_method": "POST"
  }
}

Updates a SWML Script by ID

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)

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"

Unique ID of a SWML Script.

Request

This endpoint expects an object.

display_namestringOptional

Display name of the SWML Script

contentsstringOptional

The contents of the SWML script.

status_callback_urlstringOptionalformat: "uri"

URL to send status callbacks to

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

Allowed values:

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.

Permissions

Authentication

Path parameters

Request

Response

Errors