Create call flow

POST

https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows

POST

/api/fabric/resources/call_flows

curl -X POST https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "title": "Welcome Call Flow",
  "flow_data": {},
  "relayml": {
    "sections": {
      "main": [
        {
          "play": {
            "url": "https://cdn.signalwire.com/swml/audio.mp3"
          }
        }
      ]
    },
    "version": "1.0.0"
  }
}'

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Welcome Call Flow",
  "type": "call_flow",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:25:00Z",
  "call_flow": {
    "id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "title": "Welcome Call Flow",
    "flow_data": {},
    "relayml": {
      "sections": {
        "main": [
          {
            "play": {
              "url": "https://cdn.signalwire.com/swml/audio.mp3"
            }
          }
        ]
      },
      "version": "1.0.0"
    },
    "document_version": 1
  }
}

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.

Creates a visual Call Flow in your SignalWire project. The new flow becomes a reusable call handler that can be edited in Call Flow Builder and assigned to phone numbers or other routing resources. Use [Create SWML Script](/docs/apis/rest/swml-scripts/create-swml-script) for directly authored SWML, or [Create Relay application](/docs/apis/rest/relay-application/create-relay-application) for a Server SDK 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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.

titlestringRequired

The name of the Call Flow

flow_dataobjectOptional

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.

relaymlobjectOptional

The calling SWML document this Call Flow should execute. Uses calling SWML methods. Optional but must be paired with flow_data — provide both fields together or omit both. When both are omitted, SignalWire creates a starter SWML document.

Response

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

idstringformat: "uuid"

Unique ID of the Call Flow.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the Call Flow Fabric Resource

typeenum

Type of the Fabric Resource

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

call_flowobject

Call Flow data.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error