Update cXML application

PUT

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

PUT

/api/fabric/resources/cxml_applications/:id

curl -X PUT https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_applications/id \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{}'

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

Changes where a cXML Application sends voice and messaging requests and callbacks. Compatibility Update application manages the same application by Application SID; use whichever identifier your integration holds.

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.

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)

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a cXML Application.

Request

This endpoint expects an object.

display_namestringOptional

Display name of the cXML Application

account_sidstringOptionalformat: "uuid"

Project ID for the cXML Application

voice_urlstringOptional

URL to handle incoming calls

voice_methodenumOptional

HTTP method for voice URL

Allowed values:

voice_fallback_urlstringOptional

Fallback URL for voice errors

voice_fallback_methodenumOptional

HTTP method for voice fallback URL

Allowed values:

status_callbackstringOptional

URL to receive status callbacks

status_callback_methodenumOptional

HTTP method for status callbacks

Allowed values:

sms_urlstringOptional

URL to handle incoming messages

sms_methodenumOptional

HTTP method for SMS URL

Allowed values:

sms_fallback_urlstringOptional

Fallback URL for SMS errors

sms_fallback_methodenumOptional

HTTP method for SMS fallback URL

Allowed values:

sms_status_callbackstringOptional

URL to receive SMS status callbacks

sms_status_callback_methodenumOptional

HTTP method for SMS status callbacks

Allowed values:

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

Allowed values:

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

422

Unprocessable Entity Error

500

Internal Server Error