Update a Domain Application

PUT 
/domain_applications/:id

Updates the specific domain application by setting the values of any parameters passed in. Any parameters not provided will be unchanged.

Permissions

The API token must include the following scopes: Voice.

Request

Path Parameters

id uuidrequired

Unique ID of the domain application

application/json

Body

required

oneOf

Relay Topic

call_handlerstring

Specifies that this domain application uses a Relay topic handler

Possible values: [relay_topic]

call_relay_topicstring

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

Example: office

call_relay_topic_status_callback_urlstring

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

Example: https://myapplication/handle_relay_callbacks

Relay Application

call_handlerstring

Specifies that this domain application uses a Relay application handler

Possible values: [relay_application]

call_relay_applicationstring

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

Example: my-relay-app

LaML Webhooks

call_handlerstring

Specifies that this domain application uses LaML webhooks

Possible values: [laml_webhooks]

call_request_urlstring

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

Example: https://example.com/laml

call_request_methodstring

A string representing the HTTP method to use with call_request_url.

Possible values: [GET, POST]

Example: POST

call_fallback_urlstring

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

Example: https://example.com/fallback

call_fallback_methodstring

A string representing the HTTP method to use with call_fallback_url.

Possible values: [GET, POST]

Example: POST

call_status_callback_urlstring

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

Example: https://example.com/status

call_status_callback_methodstring

A string representing the HTTP method to use with call_status_callback_url.

Possible values: [GET, POST]

Example: POST

LaML Application

call_handlerstring

Specifies that this domain application uses a LaML application

Possible values: [laml_application]

call_laml_application_idstring

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

Example: app-123456

Video Room

call_handlerstring

Specifies that this domain application uses a Video Room

Possible values: [video_room]

call_video_room_iduuid

A string representing the ID of the Video Room to forward incoming calls to.

Example: fe4093d9-58c2-4931-b4b9-5679f82652c6

Relay Script

call_handlerstring

Specifies that this domain application uses a Relay script

Possible values: [relay_script]

call_relay_script_urlstring

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

Example: https://example.com/relay-script

Dialogflow

call_handlerstring

Specifies that this domain application uses a Dialogflow agent

Possible values: [dialogflow]

call_dialogflow_agent_iduuid

A string representing the ID of the Dialogflow Agent to forward incoming calls to.

Example: fe4093d9-58c2-4931-b4b9-5679f82652c6

AI Agent

call_handlerstring

Specifies that this domain application uses an AI agent

Possible values: [ai_agent]

call_ai_agent_iduuid

A string representing the ID of the AI Agent to forward incoming calls to.

Example: fe4093d9-58c2-4931-b4b9-5679f82652c6

Call Flow

call_handlerstring

Specifies that this domain application uses a Call Flow

Possible values: [call_flow]

call_flow_iduuid

A string representing the ID of the Call Flow to forward incoming calls to.

Example: fe4093d9-58c2-4931-b4b9-5679f82652c6

call_flow_versionstring

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

Possible values: [working_copy, current_deployed]

Example: working_copy

Relay Context (Deprecated)

call_handlerstring

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

Possible values: [relay_context]

call_relay_contextstringdeprecated

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

Example: office

call_relay_context_status_callback_urlstringdeprecated

This property is deprecated. Please use call_relay_topic_status_callback_url instead.

Example: https://myapplication/handle_relay_callbacks
namestring
A string representing the friendly name for this domain application.
Example: Test App
identifierstring
A string representing the identifier portion of the domain application. Must be unique across your project. Must be letters, numbers, and dash only.
Example: test-id
ip_auth_enabledboolean
Whether the domain application will enforce IP authentication for incoming requests.
Example: true
ip_authstring[]
A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true.
Example: ["8.8.8.8","4.4.4.4"]
encryptionstring
A string representing whether connections to this domain application require encryption or if encryption is optional. Encryption will always be used if possible. Valid values are optional and required.
Example: required
codecsstring[]
A list of codecs this domain application will support. Currently supported values are OPUS, G722, PCMU, PCMA, VP8, and H264. At least one value must be supplied.
Example: ["PCMU","PCMA"]
ciphersstring[]
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. At least one value must be supplied.
Example: ["AEAD_AES_256_GCM_8"]

Responses

200

OK

application/json

Schema

Schema

links

object

selfstring

firststring

nextstring

prevstring
dataobject[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "domain_application",
      "domain": "your-space-test_id",
      "name": "Test App",
      "identifier": "test-id",
      "ip_auth_enabled": true,
      "ip_auth": [
        "8.8.8.8",
        "4.4.4.4"
      ],
      "call_handler": "relay_application",
      "call_request_url": null,
      "call_request_method": "POST",
      "call_fallback_url": null,
      "call_fallback_method": "POST",
      "call_status_callback_url": null,
      "call_status_callback_method": "POST",
      "call_relay_topic": "office",
      "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
      "call_relay_application": null,
      "call_relay_script_url": null,
      "call_laml_application_id": null,
      "call_video_room_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
      "call_dialogflow_agent_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
      "call_ai_agent_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
      "call_flow_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
      "call_flow_version": "working_copy",
      "encryption": "required",
      "codecs": [
        "PCMU",
        "PCMA"
      ],
      "ciphers": [
        "AEAD_AES_256_GCM_8"
      ]
    }
  ]
}