v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

Call Flows

Create call flow

Creates a Call Flow

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_flows

Request body

titlestring required

The name of the Call Flow

flow_dataobject

Call Flow Builder state, stored as an opaque JSON object. Optional but must be paired with relayml — provide both fields together or omit both. When both are omitted, SignalWire creates a starter Call Flow.

Example request

{
  "title": "Booking Assistant",
  "flow_data": {},
  "relayml": {
    "sections": {
      "main": [
        {
          "answer": {
            "max_duration": 3600,
            "codecs": "PCMU,PCMA,OPUS",
            "username": "user123",
            "password": "securepassword"
          }
        }
      ]
    }
  }
}

Response

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

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": {
      "sections": {
        "main": [
          {
            "answer": {
              "max_duration": 3600,
              "codecs": "PCMU,PCMA,OPUS",
              "username": "user123",
              "password": "securepassword"
            }
          }
        ]
      }
    },
    "document_version": 1
  }
}