Update cXML Application

PUT 
/resources/cxml_applications/:id

Updates a cXML Application by ID.

Request

Path Parameters

id uuidrequired

The ID of the cXML Application

application/json

Body

required

name string
handle_calls_using string

Possible values: [script, external_url]

call_handler_url uri
call_handler_method string

Possible values: [POST, GET]

call_handler_fallback_url uri
call_handler_fallback_method string

Possible values: [POST, GET]

call_status_callback_url uri
call_status_callback_method string

Possible values: [POST, GET]

call_handler_script string

Responses

200

A cXML Application

application/json

Schema

Schema

id uuid
project_id uuid
display_name string
type string
created_at date-time
updated_at date-time

cxml_application

object

id uuid

A unique identifier for the cXML Application

name string

handle_calls_using string

Possible values: [script, external_url]

call_handler_url uri

call_handler_method string

Possible values: [POST, GET]

call_handler_fallback_url uri

call_handler_fallback_method string

Possible values: [POST, GET]

call_status_callback_url uri

call_status_callback_method string

Possible values: [POST, GET]

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

422

Unprocessable Entity

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Name must be present",
  "attribute": "name",
  "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#invalid_parameter"
}

Loading...