Compatibility REST APICxml Scripts

Create a cXML Script

View as Markdown

Create a cXML script.

Permissions

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

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) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account this script is associated with.

Request

This endpoint expects an object.
NamestringRequired>=1 character
A friendly name given to the cXML script. Required.
ContentsstringOptional
The cXML contents of the script. Must be valid XML with proper Mustache syntax if templates are used. Defaults to an empty Response element.

Response

Response returned when a cXML script is created.
sidstringformat: "uuid"
The unique identifier of the cXML script on SignalWire.
date_createdstring
The date and time, in ISO 8601 format, the script was created.
date_updatedstring
The date and time, in ISO 8601 format, the script was updated.
date_last_accessedstring or null
The date and time, in ISO 8601 format, the script was last accessed, or null if never accessed.
account_sidstringformat: "uuid"
The unique identifier for the account this script is associated with.
namestring
A friendly name given to the cXML script.
contentsstring
The contents of the cXML script.
request_urlstringformat: "uri"
The unique URL to the raw contents of the cXML script.
num_requestsinteger
The number of times this cXML script has been accessed.
api_versionstring
The version of the SignalWire API.
uristring
The URL of this resource.

Errors