SWML Scripts

List SWML Scripts

Changed on

Returns the project's SWML Script resources, which store calling or messaging SWML in SignalWire. Use it to discover scripts before retrieving or changing one. Use SWML Webhooks when your server must return SWML for each request, or cXML Scripts for applications written in cXML.

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

Request

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

Response

The request has succeeded.

Example response

[
  {
    "data": [
      {
        "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"
        }
      }
    ],
    "links": {
      "self": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=0&page_size=50&type=swml_script",
      "first": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_size=50&type=swml_script",
      "next": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=swml_script",
      "prev": "https://example.signalwire.com/api/fabric/resources/swml_scripts?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=swml_script"
    }
  }
]

Changes

    • 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

    • 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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    This list may be incomplete.

Some revisions have not been checked yet.