Skip to navigation

List cXML application resources in the project.

Response

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

Response Example

Response
{
"data": [
{
"id": "993ed018-9e79-4e50-b97b-984bd5534095",
"project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
"display_name": "Reception App",
"type": "cxml_application",
"created_at": "2024-05-06T12:20:00Z",
"updated_at": "2024-05-06T12:20:00Z",
"cxml_application": {
"id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
"project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
"friendly_name": "Reception App",
"voice_url": "https://example.com/voice/incoming",
"voice_method": "GET",
"voice_fallback_url": "https://example.com/voice/fallback",
"voice_fallback_method": "GET",
"status_callback": "https://example.com/voice/status",
"status_callback_method": "GET",
"sms_url": "https://example.com/message/incoming",
"sms_method": "GET",
"sms_fallback_url": "https://example.com/message/fallback",
"sms_fallback_method": "GET",
"sms_status_callback": "https://example.com/message/status",
"sms_status_callback_method": "GET"
}
}
],
"links": {
"self": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_number=0&page_size=50&type=cxml_application",
"first": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_size=50&type=cxml_application",
"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",
"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"
}
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
project: "your-project-id",
token: "your-api-token",
host: "your-space.signalwire.com",
});
const response = await client.fabric.cxmlApplications.list();
for (const app of response.data ?? []) {
console.log(`${app.display_name}: ${app.id}`);
}