Create cXML Script | SignalWire

import requests
url = "https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts"
payload = {
    "display_name": "Reception Script",
    "contents": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><Say>Hello World</Say></Response>"
}
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

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

Creates a cXML Script

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.

display_namestringRequired

Display name of the cXML Script

contentsstringRequired

The cXML script contents

status_callback_urlstringOptionalformat: "uri"

URL to send status callbacks to

status_callback_methodenumOptional

HTTP method to use for status callbacks

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the cXML Script.

project_idstringformat: "uuid"

Unique ID of the Project.

namestring

Display name of the cXML Script Fabric Resource

typeenum

Type of the Fabric Resource

Allowed values:

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

cxml_scriptobject

cXML Script data.

Permissions

Authentication

Request

Response

Errors