Get cXML Application

GET 
/resources/cxml_applications/:id

Returns a cXML Application by ID.

Request

Path Parameters

id uuidrequired

The ID of the cXML Application

Responses

200

A cXML Application

application/json

Schema

Schema

iduuid
Example: 993ed018-9e79-4e50-b97b-984bd5534095
project_iduuid
Example: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
display_namestring
Example: Reception
typestring
Example: cxml_application
created_atdate-time
Example: 2024-01-02T00:00:00Z
updated_atdate-time
Example: 2024-01-02T00:00:00Z

cxml_application

object

iduuid

A unique identifier for the cXML Application

namestring

Example: Booking Assistant

handle_calls_usingstring

Possible values: [script, external_url]

Example: script

call_handler_urluri

Example: https://example.com/cxml

call_handler_methodstring

Possible values: [POST, GET]

Example: POST

call_handler_fallback_urluri

Example: https://example.com/cxml

call_handler_fallback_methodstring

Possible values: [POST, GET]

Example: POST

call_status_callback_urluri

Example: https://example.com/cxml

call_status_callback_methodstring

Possible values: [POST, GET]

Example: POST

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception",
  "type": "cxml_application",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "cxml_application": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Booking Assistant",
    "handle_calls_using": "script",
    "call_handler_url": "https://example.com/cxml",
    "call_handler_method": "POST",
    "call_handler_fallback_url": "https://example.com/cxml",
    "call_handler_fallback_method": "POST",
    "call_status_callback_url": "https://example.com/cxml",
    "call_status_callback_method": "POST"
  }
}