Sign in
Space Domain Applications

Update domain application

Changes how a project SIP domain authenticates endpoints, handles media, or routes inbound calls. Use Assign domain application handler when assigning an existing Fabric resource as the calling handler.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, or Fax.

Learn more about API scopes.

put/api/relay/rest/domain_applications/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the domain application.

Request body

namestring

A string representing the friendly name for this domain application.

identifierstring

A string representing the identifier portion of the domain application.

userstring

A string representing the user portion of the domain application.

ip_auth_enabledboolean

Whether the domain application will enforce IP authentication for incoming requests.

ip_authstring[]

A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true.

encryption'optional' | 'required' | 'forbidden'

Whether connections to this domain application require encryption or if encryption is optional.

codecsstring[]

A list of codecs this domain application will support.

ciphersstring[]

A list of encryption ciphers this domain application will support.

call_handler'relay_topic' | 'relay_application' | 'laml_webhooks' | 'laml_application' | 'video_room' | 'relay_script' | 'dialogflow' | 'ai_agent' | 'call_flow' | 'relay_context'

Call handler types that can be assigned via the API.

call_relay_topicstring

A string representing the Relay topic to forward incoming calls to.

call_relay_topic_status_callback_urlstring

A string representing a URL to send status change messages to.

call_relay_applicationstring

A string representing the Relay Application to forward incoming calls to.

call_request_urlstring

A string representing the LaML URL to access when a call is received.

call_request_method'GET' | 'POST'

A string representing the HTTP method to use with call_request_url.

call_fallback_urlstring

A string representing the LaML URL to access when the call to call_request_url fails.

call_fallback_method'GET' | 'POST'

A string representing the HTTP method to use with call_fallback_url.

call_status_callback_urlstring

A string representing a URL to send status change messages to.

call_status_callback_method'GET' | 'POST'

A string representing the HTTP method to use with call_status_callback_url.

call_laml_application_idstring

A string representing the ID of the LaML application to forward incoming calls to.

call_video_room_idstring uuid

Universal Unique Identifier.

call_relay_script_urlstring

A string representing the URL of the Relay script to execute when a call is received.

call_dialogflow_agent_idstring uuid

Universal Unique Identifier.

call_ai_agent_idstring uuid

Universal Unique Identifier.

call_flow_idstring uuid

Universal Unique Identifier.

call_flow_version'working_copy' | 'current_deployed'

A string representing the version of your Call Flow you'd like to use.

call_relay_contextstring

This handler type is deprecated. Please use call_relay_application or call_relay_topic instead.

call_relay_context_status_callback_urlstring

This property is deprecated. Please use call_relay_topic_status_callback_url instead.

Example request

{
  "name": "Test App",
  "user": "helpdesk",
  "ip_auth_enabled": true,
  "encryption": "required",
  "call_relay_topic": "office",
  "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
  "call_relay_application": "my-relay-app",
  "call_request_url": "https://example.com/laml",
  "call_fallback_url": "https://example.com/fallback",
  "call_status_callback_url": "https://example.com/status",
  "call_laml_application_id": "app-123456",
  "call_relay_script_url": "https://example.com/relay-script",
  "call_relay_context": "office",
  "call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

typestring required

A string representation of the type of object this record is.

domainstring required

The unique domain for this application, combining your space subdomain and identifier.

namestring nullable required

A string representing the friendly name for this domain application.

identifierstring required

A string representing the identifier portion of the domain application.

userstring required

A string representing the user portion of the domain application.

ip_auth_enabledboolean required

Whether the domain application will enforce IP authentication for incoming requests.

ip_authstring[] required

A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true.

call_handler'relay_topic' | 'relay_application' | 'laml_webhooks' | 'laml_application' | 'video_room' | 'relay_script' | 'dialogflow' | 'ai_agent' | 'call_flow' | 'relay_context' | 'relay_connector' | 'fabric_subscriber' | 'sip_gateway' | 'call_queue' required

All possible call handler types for domain applications. Includes types that can only be assigned via the Fabric API or UI.

calling_handler_resource_idstring uuid required

Universal Unique Identifier.

call_relay_topicstring nullable required

A string representing the Relay topic to forward incoming calls to.

call_relay_topic_status_callback_urlstring nullable required

A string representing a URL to send status change messages to.

call_relay_contextstring nullable required

Deprecated. Use call_relay_application instead.

call_relay_context_status_callback_urlstring nullable required

Deprecated. Use call_relay_topic_status_callback_url instead.

call_request_urlstring nullable required

A string representing the LaML URL to access when a call is received.

call_request_method'GET' | 'POST' nullable required

A string representing the HTTP method to use with call_request_url.

call_fallback_urlstring nullable required

A string representing the LaML URL to access when the call to call_request_url fails.

call_fallback_method'GET' | 'POST' nullable required

A string representing the HTTP method to use with call_fallback_url.

call_status_callback_urlstring nullable required

A string representing a URL to send status change messages to.

call_status_callback_method'GET' | 'POST' nullable required

A string representing the HTTP method to use with call_status_callback_url.

call_laml_application_idstring nullable required

A string representing the ID of the LaML application to forward incoming calls to.

call_video_room_idstring uuid required

Universal Unique Identifier.

call_relay_script_urlstring nullable required

A string representing the URL of the Relay script to execute when a call is received.

encryption'optional' | 'required' | 'forbidden' required

A string representing whether connections to this domain application require encryption or if encryption is optional. Valid values are optional, required, and forbidden.

codecsstring[] required

A list of codecs this domain application will support. Currently supported values are: OPUS, G722, PCMU, PCMA, G729, VP8, and H264.

ciphersstring[] required

A list of encryption ciphers this domain application will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, and AES_CM_128_HMAC_SHA1_32.

Example response

{
  "type": "domain_application",
  "domain": "your-space-test_id",
  "name": "Test App",
  "user": "helpdesk",
  "ip_auth_enabled": true,
  "call_relay_topic": "office",
  "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
  "call_relay_context": "office",
  "call_request_url": "https://example.com/laml",
  "call_fallback_url": "https://example.com/fallback",
  "call_status_callback_url": "https://example.com/status",
  "call_laml_application_id": "app-123456",
  "call_relay_script_url": "https://example.com/relay-script",
  "encryption": "required"
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.