Create a Domain Application
POST/domain_applications
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
- application/json
Body
required
A string representing the friendly name for this domain application.
A string representing the identifier portion of the domain application. Must be unique across your project. Must be letters, numbers, and dash only.
Whether the domain application will enforce IP authentication for incoming requests.
A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled
is true
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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.
A string representing a URL to send status change messages to. This is only used (and required) when call_handler
is set to relay_context
.
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.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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.
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
- application/json
- Schema
- Example (from schema)
Schema
The unique identifier of the domain application on SignalWire. This can be used to update or delete the application programmatically.
A string representation of the type of object this record is.
A string representation of the subdomain for this application.
A string representing the friendly name for this domain application.
A string representing the identifier portion of the domain application. Must be unique across your project. Must be letters, numbers, and dash only.
Whether the domain application will enforce IP authentication for incoming requests.
A list containing whitelisted IP addresses and IP blocks used if ip_auth_enabled
is true
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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.
A string representing a URL to send status change messages to. This is only used (and required) when call_handler
is set to relay_context
.
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.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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.
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.
{
"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_context": "office",
"call_relay_context_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"
]
}