Get Call Flow

GET 
/resources/call_flows/:id

Returns a Call Flow by ID.

Request

Path Parameters

id uuidrequired

The ID of the Call Flow

Responses

200

A Call Flow

application/json

Schema

Schema

id uuid
Example: 993ed018-9e79-4e50-b97b-984bd5534095
project_id uuid
Example: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
display_name string
Example: Booking Assistant
type string
Example: call_flow
created_at date-time
Example: 2024-01-02T00:00:00Z
updated_at date-time
Example: 2024-01-02T00:00:00Z

call_flow

object

id uuid

A unique identifier for the Call Flow

title string

The name of the Call Flow

Example: Booking Assistant

flow_data string

Example: {}

relayml string

A SWML document. For more information on SWML, please go to https://developer.signalwire.com/swml

Example: {}

document_version integer

The current revision of the call flow. Every update must increase this number.

Example: 1

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Booking Assistant",
  "type": "call_flow",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "call_flow": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Booking Assistant",
    "flow_data": "{}",
    "relayml": "{}",
    "document_version": 1
  }
}