Create a Domain Application

To create a new domain application, you send a POST request to the domain application resource.

Permissions

The API token must include the following scopes: Voice.

Request Body — REQUIRED
name string — REQUIRED A string representing the friendly name for this domain application.
identifier string — REQUIRED A string representing the identifier portion of the domain application. Must be unique across your project. Must be letters, numbers, and dash only.
ip_auth_enabled boolean Whether the domain application will enforce IP authentication for incoming requests.
ip_auth string[] A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true.
call_handler string — REQUIRED A string representing how this domain application handles calls. Valid values are relay_context, relay_application, laml_webhooks, laml_application, video_room, relay_script, dialogflow, ai_agent, and call_flow.
call_request_url string A string representing the LaML URL to access when a call is received. This is only used (and required) when call_handler is set to laml_webhooks.
call_request_method string A string representing the HTTP method to use with call_request_url. Valid values are GET and POST. This is only used (and required) when call_handler is set to laml_webhooks.
call_fallback_url string A string representing the LaML URL to access when the call to call_request_url fails. This is only used (and required) when call_handler is set to laml_webhooks.
call_fallback_method string A string representing the HTTP method to use with call_fallback_url. Valid values are GET and POST. This is only used (and required) when call_handler is set to laml_webhooks.
call_status_callback_url string A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to laml_webhooks.
call_status_callback_method string A string representing the HTTP method to use with call_status_callback_url. Valid values are GET and POST. This is only used (and required) when call_handler is set to laml_webhooks.
call_relay_context string A string representing the Relay context to forward incoming calls to. This is only used (and required) when call_handler is set to relay_context. Alias of call_relay_application. If both are sent, call_relay_application takes precedence.
call_relay_application string A string representing the Relay Application to forward incoming calls to. This is only used (and required) when call_handler is set to relay_application. Alias of call_relay_context. If both are sent, call_relay_application takes precedence.
call_relay_script_url string A string representing the URL of the Relay script to execute when a call is received. This is only used (and required) when call_handler is set to relay_script.
call_laml_application_id string A string representing the ID of the LaML application to forward incoming calls to. This is only used (and required) when call_handler is set to laml_application.
call_video_room_id uuid A string representing the ID of the Video Room to forward incoming calls to. This is only used (and required) when call_handler is set to video_room.
call_dialogflow_agent_id uuid A string representing the ID of the Dialogflow Agent to forward incoming calls to. This is only used (and required) when call_handler is set to dialogflow.
call_ai_agent_id uuid A string representing the ID of the AI Agent to forward incoming calls to. This is only used (and required) when call_handler is set to ai_agent.
call_flow_id uuid A string representing the ID of the Call Flow to forward incoming calls to. This is only used (and required) when call_handler is set to call_flow.
call_flow_version string A string representing the version of your Call Flow you'd like to use. Valid options are working_copy or current_deployed. This is only used when call_handler is set to call_flow.
encryption string 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.
codecs string[] 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.
ciphers string[] 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.

Responses

201 CREATED Schema — OPTIONAL id uuid The unique identifier of the domain application on SignalWire. This can be used to update or delete the application programmatically. type string — OPTIONAL A string representation of the type of object this record is. domain string — OPTIONAL A string representation of the subdomain for this application. name string A string representing the friendly name for this domain application. identifier string A string representing the identifier portion of the domain application. Must be unique across your project. Must be letters, numbers, and dash only. ip_auth_enabled boolean — OPTIONAL Whether the domain application will enforce IP authentication for incoming requests. ip_auth string[] — OPTIONAL A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled is true. call_handler string A string representing how this domain application handles calls. Valid values are relay_context, relay_application, laml_webhooks, laml_application, video_room, relay_script, dialogflow, ai_agent, and call_flow. call_request_url string — OPTIONAL A string representing the LaML URL to access when a call is received. This is only used (and required) when call_handler is set to laml_webhooks. call_request_method string — OPTIONAL A string representing the HTTP method to use with call_request_url. Valid values are GET and POST. This is only used (and required) when call_handler is set to laml_webhooks. call_fallback_url string — OPTIONAL A string representing the LaML URL to access when the call to call_request_url fails. This is only used (and required) when call_handler is set to laml_webhooks. call_fallback_method string — OPTIONAL A string representing the HTTP method to use with call_fallback_url. Valid values are GET and POST. This is only used (and required) when call_handler is set to laml_webhooks. call_status_callback_url string — OPTIONAL A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to laml_webhooks. call_status_callback_method string — OPTIONAL A string representing the HTTP method to use with call_status_callback_url. Valid values are GET and POST. This is only used (and required) when call_handler is set to laml_webhooks. call_relay_context string — OPTIONAL A string representing the Relay context to forward incoming calls to. This is only used (and required) when call_handler is set to relay_context. Alias of call_relay_application. If both are sent, call_relay_application takes precedence. call_relay_application string — OPTIONAL A string representing the Relay Application to forward incoming calls to. This is only used (and required) when call_handler is set to relay_application. Alias of call_relay_context. If both are sent, call_relay_application takes precedence. call_relay_script_url string — OPTIONAL A string representing the URL of the Relay script to execute when a call is received. This is only used (and required) when call_handler is set to relay_script. call_laml_application_id string — OPTIONAL A string representing the ID of the LaML application to forward incoming calls to. This is only used (and required) when call_handler is set to laml_application. call_video_room_id uuid — OPTIONAL A string representing the ID of the Video Room to forward incoming calls to. This is only used (and required) when call_handler is set to video_room. call_dialogflow_agent_id uuid — OPTIONAL A string representing the ID of the Dialogflow Agent to forward incoming calls to. This is only used (and required) when call_handler is set to dialogflow. call_ai_agent_id uuid — OPTIONAL A string representing the ID of the AI Agent to forward incoming calls to. This is only used (and required) when call_handler is set to ai_agent. call_flow_id uuid — OPTIONAL A string representing the ID of the Call Flow to forward incoming calls to. This is only used (and required) when call_handler is set to call_flow. call_flow_version string — OPTIONAL A string representing the version of your Call Flow you'd like to use. Valid options are working_copy or current_deployed. This is only used when call_handler is set to call_flow. encryption string — OPTIONAL 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. codecs string[] — OPTIONAL 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. ciphers string[] — OPTIONAL 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.