SWML Scripts

Get SWML Script

Retrieves one stored SWML Script by resource ID so you can inspect the instructions used by its calling or messaging handler. Use List SWML Scripts to discover IDs, or a SWML Webhook when instructions must come from your server at request time.

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.

get/api/fabric/resources/swml_scripts/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a SWML Script.

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

Changed in 33 of the 161 revisions of this API.140184450

  • e79dcc8b215024See the full diff
    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-unevaluated-properties-added

    • ○

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

      response-property-unevaluated-properties-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the //////////////////// response property anyOf list for the response status

      response-property-any-of-removed

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the //////////////////// response property anyOf list for the response status

      response-property-any-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the //////////////////// response property anyOf list for the response status

      response-property-any-of-removed

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the //////////////////// response property anyOf list for the response status

      response-property-any-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 549e44d6120b6436See the full diff
    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property //////////////////////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ////////////////////// became optional for the status

      response-property-became-optional

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the //////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #2 to the ////////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added subschema #1 subschema #2 subschema #3 subschema #4 to the //////////////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the //////////////////// response property anyOf list for the response status

      response-property-any-of-removed

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the //////////////////// response property anyOf list for the response status

      response-property-any-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      removed the optional property /////////////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /////////////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /////////////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /////////////////// from the response with the status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ●

      removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////////// to the response with the status

      response-optional-property-added

    • ○

      the response's property default value changed from gcloud_speech_v2_async to deepgram:nova-3 for the status

      response-property-default-value-changed

    • ○

      the response's property default value changed from gcloud_speech_v2_async to deepgram:nova-3 for the status

      response-property-default-value-changed

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 161 revisions, 3 have a changelog that could not be searched.