deployVersion | SignalWire

Deploy a specific version of a call flow resource.

Path parameters

idstringRequired

The unique identifier of the Call Flow.

Request

Deploy by document versionobjectRequired

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_datastringOptional

Call Flow data structure

relaymlstringOptional

SWML document for this version

Response Example

Response

1 {
2   "id": "993ed018-9e79-4e50-b97b-984bd5534095",
3   "created_at": "2024-01-02T00:00:00Z",
4   "updated_at": "2024-01-02T00:00:00Z",
5   "document_version": 2,
6   "flow_data": "{}",
7   "relayml": "{ \"version\": \"1.0.0\", \"sections\": { \"main\": [{ \"play\": { \"url\": \"https://cdn.signalwire.com/swml/audio.mp3\" }}]}};"
8 }

Example

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