Call Flows

Deploy call flow version

Changed on

Makes one saved Call Flow version active, selected by document version or version ID. Use it after updating a visual flow when that revision is ready to handle calls; updating the Call Flow saves a revision but does not replace this deployment step. Directly authored SWML Scripts do not use Call Flow versions.

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

Request

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

Path parameters

idstring required

The unique identifier of the Call Flow.

Request body

OR

Example request

{
  "document_version": 2
}

Response

The request has succeeded and a new resource has been created as a result.

idstring uuid required

Universal Unique Identifier.

created_atstring required

The creation timestamp.

updated_atstring required

The last update timestamp.

document_versioninteger required

The document version.

flow_dataobject

Call Flow Builder state, stored as an opaque JSON object.

relaymlobject

The calling SWML document deployed by this version. Uses calling SWML methods.

Example response

{
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "document_version": 2,
  "flow_data": {},
  "relayml": {
    "version": "1.0.0",
    "sections": {
      "main": [
        {
          "play": {
            "url": "https://cdn.signalwire.com/swml/audio.mp3"
          }
        }
      ]
    }
  }
}

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.