List cXML applications

GET

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

GET

/api/fabric/resources/cxml_applications

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

{
  "data": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "display_name": "Reception App",
      "type": "cxml_application",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "cxml_application": {
        "id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
        "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
        "friendly_name": "Reception App",
        "voice_url": "https://example.com/voice/incoming",
        "voice_method": "GET",
        "voice_fallback_url": "https://example.com/voice/fallback",
        "voice_fallback_method": "GET",
        "status_callback": "https://example.com/voice/status",
        "status_callback_method": "GET",
        "sms_url": "https://example.com/message/incoming",
        "sms_method": "GET",
        "sms_fallback_url": "https://example.com/message/fallback",
        "sms_fallback_method": "GET",
        "sms_status_callback": "https://example.com/message/status",
        "sms_status_callback_method": "GET"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_number=0&page_size=50&type=cxml_application",
    "first": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_size=50&type=cxml_application",
    "next": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=cxml_application",
    "prev": "https://example.signalwire.com/api/fabric/resources/cxml_applications?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=cxml_application"
  }
}

Lists the project’s addressable cXML Applications, which provide reusable voice and messaging routing. These are the same applications exposed by the Compatibility API’s Applications, which is also where new ones are created. Use cXML Webhooks when your server supplies cXML for each request.

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 Applications, which provide reusable voice and messaging routing. These are the same applications exposed by the Compatibility API's [Applications](/docs/compatibility-api/rest/applications/list-applications), which is also where new ones are created. Use [cXML Webhooks](/docs/apis/rest/cxml-webhook/list-cxml-webhooks) when your server supplies cXML for each request. #### 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 the list of cXML Application(s) data.

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error