REST ClientFabricCall Flows

deployVersion

View as MarkdownOpen in Claude

Deploy a specific version of a call flow resource.

Path parameters

idstringRequired
The unique identifier of the Call Flow.

Request

Deploy by document versionobjectRequired
OR
Deploy by version IDobjectRequired

Response

idstringRequiredformat: "uuid"
The unique identifier of the deployed Call Flow Version.
created_atstringRequired
The creation timestamp.
updated_atstringRequired
The last update timestamp.
document_versionintegerRequired
The document version.
flow_dataobjectOptional
Call Flow Builder state, stored as an opaque JSON object.
relaymlobjectOptional
The calling SWML document deployed by this version. Uses [calling SWML methods](/docs/swml/reference/calling).

Response Example

Response
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "created_at": "2024-05-06T12:20:00Z",
4  "updated_at": "2024-05-06T12:25:00Z",
5  "document_version": 2,
6  "flow_data": {},
7  "relayml": {
8    "sections": {
9      "main": [
10        {
11          "play": {
12            "url": "https://cdn.signalwire.com/swml/audio.mp3"
13          }
14        }
15      ]
16    },
17    "version": "1.0.0"
18  }
19}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const result = await client.fabric.callFlows.deployVersion("call-flow-id", {
10  call_flow_version_id: "version-id",
11});
12console.log(`Deployed version: ${result.id}`);