list | SignalWire

List cXML application resources in the project.

Response

datalist of objectsRequired

An array of objects containing the list of cXML Application(s) data.

linksobjectRequired

Object containing pagination links

Response Example

Response

1 {
2   "data": [
3     {
4       "id": "993ed018-9e79-4e50-b97b-984bd5534095",
5       "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
6       "display_name": "Reception App",
7       "type": "cxml_application",
8       "created_at": "2024-05-06T12:20:00Z",
9       "updated_at": "2024-05-06T12:20:00Z",
10       "cxml_application": {
11         "id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
12         "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
13         "friendly_name": "Reception App",
14         "voice_url": "https://example.com/voice/incoming",
15         "voice_method": "GET",
16         "voice_fallback_url": "https://example.com/voice/fallback",
17         "voice_fallback_method": "GET",
18         "status_callback": "https://example.com/voice/status",
19         "status_callback_method": "GET",
20         "sms_url": "https://example.com/message/incoming",
21         "sms_method": "GET",
22         "sms_fallback_url": "https://example.com/message/fallback",
23         "sms_fallback_method": "GET",
24         "sms_status_callback": "https://example.com/message/status",
25         "sms_status_callback_method": "GET"
26       }
27     }
28   ],
29   "links": {
30     "self": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_number=0&page_size=50&type=cxml_application",
31     "first": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_size=50&type=cxml_application",
32     "next": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=cxml_application",
33     "prev": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=cxml_application"
34   }
35 }

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