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
        • cXML Scripts
          • create
          • delete
          • get
          • list
          • listAddresses
          • update
        • 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 Scripts

get

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

list

Next
Built with

Retrieve a single cXML script resource.

Path parameters

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

Response

idstringRequiredformat: "uuid"
Unique ID of the cXML Script.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
namestringRequired
Display name of the cXML Script 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_scriptobjectRequired
cXML Script data.

Response Example

Response
1{
2 "id": "993ed018-9e79-4e50-b97b-984bd5534095",
3 "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4 "name": "Reception Script",
5 "type": "cxml_script",
6 "created_at": "2024-05-06T12:20:00Z",
7 "updated_at": "2024-05-06T12:20:00Z",
8 "cxml_script": {
9 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10 "contents": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Say>Hello World</Say></Response>",
11 "request_count": 5,
12 "last_accessed_at": "2023-10-01T12:00:00Z",
13 "request_url": "https://example.signalwire.com/laml-bins/2537c89e-2606-48c2-b3c2-bb601d863d1e",
14 "script_type": "calling",
15 "display_name": "Booking Assistant Script",
16 "status_callback_url": "https://example.com/cxml/status",
17 "status_callback_method": "POST"
18 }
19}

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 item = await client.fabric.cxmlScripts.get("resource-id");
10console.log(`Cxml Script: ${item.name}, ID: ${item.id}`);