REST ClientFabricCall Flows

list

View as MarkdownOpen in Claude

List call flow resources in the project.

Response

datalist of objectsRequired
An array of objects containing the CallFlow listing response

Response Example

Response
1{
2  "links": {
3    "self": "https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=call_flow",
4    "first": "https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=call_flow",
5    "next": "https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=call_flow",
6    "prev": "https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=call_flow"
7  },
8  "data": [
9    {
10      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
11      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
12      "display_name": "Booking Assistant",
13      "type": "call_flow",
14      "created_at": "2024-05-06T12:20:00Z",
15      "updated_at": "2024-05-06T12:20:00Z",
16      "call_flow": {
17        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
18        "title": "Booking Assistant",
19        "flow_data": {},
20        "relayml": {
21          "sections": {
22            "main": [
23              {
24                "denoise": {},
25                "play": {
26                  "url": "https://cdn.signalwire.com/swml/audio.mp3"
27                }
28              }
29            ]
30          },
31          "version": "1.0.0"
32        },
33        "document_version": 1
34      }
35    }
36  ]
37}

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 response = await client.fabric.callFlows.list();
10for (const flow of response.data ?? []) {
11  console.log(`${flow.display_name}: ${flow.id}`);
12}