SWML Scripts

Create SWML Script

Changed on

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 when your server must generate different SWML for each request, or 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.

post/api/fabric/resources/swml_scripts

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/swml_scripts
  • Auth
    HTTP basic

Request body

OR

Example request

{
  "name": "Welcome Script",
  "script_type": "calling",
  "status_callback_url": "https://example.com/status"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the SWML Script Fabric Resource

type'swml_script' required

Type of the Fabric Resource

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "display_name": "Welcome Script",
  "type": "swml_script",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "swml_script": {
    "display_name": "Booking Assistant",
    "script_type": "calling",
    "request_url": "https://example.com/swml_script",
    "contents": {
      "version": "1.0.0",
      "sections": {
        "main": [
          {
            "play": {
              "url": "https://cdn.signalwire.com/swml/audio.mp3"
            }
          }
        ]
      }
    },
    "status_callback_url": "https://website.com/status",
    "status_callback_method": "POST"
  }
}

Changes

  • d5b2a65b9941Revision changes
    • info

      request property / list-of-types was widened by adding types string to media type application/json

    • info

      request property / list-of-types was widened by adding types string to media type application/json

    • info

      removed 'unevaluatedProperties' constraint from the request property /

    • info

      removed 'unevaluatedProperties' constraint from the request property /

  • e79dcc8b2150Revision changes
    • breaking

      the / request property type changed from no type to object

    • breaking

      the / request property type changed from no type to object

    • breaking

      added 'unevaluatedProperties' constraint to the request property /

    • breaking

      added 'unevaluatedProperties' constraint to the request property /

    • breaking

      the /// response's property type changed from no type to object for status

    • breaking

      the /// response's property type changed from no type to object for status

    • warning

      removed from the / request property allOf list

    • warning

      removed from the / request property allOf list

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      added 'unevaluatedProperties' constraint to the /// response property for the status

    • info

      added 'unevaluatedProperties' constraint to the /// response property for the status

Some revisions have not been checked yet.