Call Flows

Retrieves one Call Flow from your SignalWire project for viewing or editing. Use List call flows to find flows, or Get SWML Script for a directly authored SWML handler.

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/call_flows/{id}

Request

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

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a Call Flow.

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 Call Flow Fabric Resource

type'call_flow' 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": "Booking Assistant",
  "type": "call_flow",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "call_flow": {
    "title": "Booking Assistant",
    "flow_data": {},
    "relayml": {
      "version": "1.0.0",
      "sections": {
        "main": [
          {
            "play": {
              "url": "https://cdn.signalwire.com/swml/audio.mp3"
            }
          }
        ]
      }
    },
    "document_version": 1
  }
}

Changes

    • 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

      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.