Get cXML application

GET

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

GET

/api/fabric/resources/cxml_applications/:id

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

{
  "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"
  }
}

Retrieves one cXML Application resource by ID so you can inspect its voice and messaging routing. Use List cXML applications to discover IDs, or Compatibility Get application when your integration holds an Application SID.

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.

Retrieves one cXML Application resource by ID so you can inspect its voice and messaging routing. Use [List cXML applications](/docs/apis/rest/cxml-applications/list-cxml-applications) to discover IDs, or Compatibility [Get application](/docs/compatibility-api/rest/applications/get-application) when your integration holds an Application SID. #### 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) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a cXML Application.

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the cXML Application.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the cXML Application Fabric Resource

typeenum

Type of the Fabric Resource

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

cxml_applicationobject

cXML Application data.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error