List cXML Scripts

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts

GET

/api/fabric/resources/cxml_scripts

curl https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_scripts \
     -u "<project_id>:<api_token>"

{
  "data": [
    {
      "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"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_number=0&page_size=50&type=cxml_script",
    "first": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_size=50&type=cxml_script",
    "next": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_number=1&page_size=50&page_token=PA08cdad0c-e7e6-4a75-8244-902524f38d55&type=cxml_script",
    "prev": "https://example.signalwire.com/api/fabric/resources/cxml_scripts?page_number=0&page_size=50&page_token=PA08cdad0c-e7e6-4a75-8244-902524f38d55&type=cxml_script"
  }
}

Lists the project’s addressable cXML Scripts, which store calling or messaging instructions in SignalWire. These are the same scripts the Compatibility API exposes as LamlBins, addressed there by SID. Use cXML Webhooks when your server must return cXML for each request, or SWML Scripts for SWML applications.

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.

Lists the project's addressable cXML Scripts, which store calling or messaging instructions in SignalWire. These are the same scripts the Compatibility API exposes as [LamlBins](/docs/compatibility-api/rest/cxml-scripts/list-cxml-scripts), addressed there by SID. Use [cXML Webhooks](/docs/apis/rest/cxml-webhook/list-cxml-webhooks) when your server must return cXML for each request, or [SWML Scripts](/docs/apis/rest/swml-scripts/list-swml-scripts) for SWML applications. #### 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](/docs/platform/your-signalwire-api-space).

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

Response

The request has succeeded.

datalist of objects

An array of objects containing a list of cXML Script data

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error