For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
      • Datasphere
      • Fabric
        • Addresses
        • AI Agents
        • Call Flows
        • Conference Rooms
        • cXML Applications
          • delete
          • get
          • list
          • listAddresses
          • update
        • cXML Scripts
        • cXML Webhooks
        • FreeSWITCH Connectors
        • RELAY Applications
        • Resources
        • SIP Endpoints
        • SIP Gateways
        • Subscribers
        • SWML Scripts
        • SWML Webhooks
        • Tokens
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientFabriccXML Applications

get

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

list

Next
Built with

Retrieve a single cXML application resource.

Path parameters

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

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 app = await client.fabric.cxmlApplications.get("app-id");
10console.log("cXML Application:", app.display_name, "ID:", app.id);