REST ClientFabriccXML Applications

update

View as MarkdownOpen in Claude

Replace a cXML application resource. Uses PUT, so the full resource body must be provided.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a cXML Application.

Request

display_namestringOptional
Display name of the cXML Application
account_sidstringOptionalformat: "uuid"
Project ID for the cXML Application
voice_urlstringOptional
URL to handle incoming calls
voice_methodenumOptional
HTTP method for voice URL
voice_fallback_urlstringOptional
Fallback URL for voice errors
voice_fallback_methodenumOptional
HTTP method for voice fallback URL
status_callbackstringOptional
URL to receive status callbacks
status_callback_methodenumOptional
HTTP method for status callbacks
sms_urlstringOptional
URL to handle incoming messages
sms_methodenumOptional
HTTP method for SMS URL
sms_fallback_urlstringOptional
Fallback URL for SMS errors
sms_fallback_methodenumOptional
HTTP method for SMS fallback URL
sms_status_callbackstringOptional
URL to receive SMS status callbacks
sms_status_callback_methodenumOptional
HTTP method for SMS status callbacks

Response

idstringRequiredformat: "uuid"
Unique ID of the cXML Application.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the cXML Application Fabric Resource
typeenumRequired
Type of the Fabric Resource
Allowed values:
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
cxml_applicationobjectRequired
cXML Application data.

Response Example

Response
1{
2  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
3  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4  "display_name": "Reception App",
5  "type": "cxml_application",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "cxml_application": {
9    "id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
10    "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
11    "friendly_name": "Reception App",
12    "voice_url": "https://example.com/voice/incoming",
13    "voice_method": "GET",
14    "voice_fallback_url": "https://example.com/voice/fallback",
15    "voice_fallback_method": "GET",
16    "status_callback": "https://example.com/voice/status",
17    "status_callback_method": "GET",
18    "sms_url": "https://example.com/message/incoming",
19    "sms_method": "GET",
20    "sms_fallback_url": "https://example.com/message/fallback",
21    "sms_fallback_method": "GET",
22    "sms_status_callback": "https://example.com/message/status",
23    "sms_status_callback_method": "GET"
24  }
25}

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 updated = await client.fabric.cxmlApplications.update("app-id", {
10  display_name: "updated-cxml-app",
11});
12console.log("Updated:", updated.display_name);