Create domain application

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.

Creates a SIP Domain Application that accepts inbound SIP traffic on its generated domain and routes calls to the configured handler. Use it for inbound bring-your-own-carrier or other custom SIP-domain routing. If the handler is an already-created Fabric resource, create the Domain Application first, then use [Assign domain application handler](/docs/apis/rest/domain-applications/assign-resource-domain-application). #### 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](/docs/platform/your-signalwire-api-space).

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)

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) ```

Request

This endpoint expects an object.

namestringRequired

A string representing the friendly name for this domain application.

identifierstringRequired

A string representing the identifier portion of the domain application.

userstringOptionalDefaults to *

The user portion of the domain application.

ip_auth_enabledbooleanOptional

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

ip_authlist of stringsOptionalDefaults to []

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

encryptionenumOptionalDefaults to optional

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

codecslist of stringsOptionalDefaults to ["PCMU","PCMA"]

A list of codecs this domain application will support.

cipherslist of stringsOptionalDefaults to

["AEAD_AES_256_GCM_8","AES_256_CM_HMAC_SHA1_80","AES_CM_128_HMAC_SHA1_80","AES_256_CM_HMAC_SHA1_32","AES_CM_128_HMAC_SHA1_32"]

A list of encryption ciphers this domain application will support.

call_handlerenumOptional

Specify how the domain application will handle calls.

call_relay_topicstringOptional

A string representing the Relay topic to forward incoming calls to. Required when call_handler is relay_topic.

call_relay_topic_status_callback_urlstringOptional

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

call_relay_applicationstringOptional

A string representing the Relay Application to forward incoming calls to. Required when call_handler is relay_application.

call_request_urlstringOptional

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

call_request_methodenumOptionalDefaults to POST

A string representing the HTTP method to use with call_request_url.

call_fallback_urlstringOptional

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

call_fallback_methodenumOptionalDefaults to POST

A string representing the HTTP method to use with call_fallback_url.

call_status_callback_urlstringOptional

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

call_status_callback_methodenumOptionalDefaults to POST

A string representing the HTTP method to use with call_status_callback_url.

call_laml_application_idstringOptional

A string representing the ID of the LaML application to forward incoming calls to. Required when call_handler is laml_application.

call_video_room_idstringOptionalformat: "uuid"

A string representing the ID of the Video Room to forward incoming calls to. Required when call_handler is video_room.

call_relay_script_urlstringOptional

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

call_dialogflow_agent_idstringOptionalformat: "uuid"

A string representing the ID of the Dialogflow Agent to forward incoming calls to. Required when call_handler is dialogflow.

call_ai_agent_idstringOptionalformat: "uuid"

A string representing the ID of the AI Agent to forward incoming calls to. Required when call_handler is ai_agent.

call_flow_idstringOptionalformat: "uuid"

A string representing the ID of the Call Flow to forward incoming calls to. Required when call_handler is call_flow.

call_flow_versionenumOptional

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

call_relay_contextstringOptionalDeprecated

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

call_relay_context_status_callback_urlstringOptionalDeprecated

This property is deprecated. Please use call_relay_topic_status_callback_url instead.

Response

The request has succeeded and a new resource has been created as a result.

idstringformat: "uuid"

The unique identifier of the domain application on SignalWire.

typestring

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

domainstring

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

namestring or null

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_authlist of strings

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

call_handlerenum or null

Specify how the domain application will handle calls.

calling_handler_resource_idstring or nullformat: "uuid"

The unique identifier of the calling handler resource.

call_relay_topicstring or null

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

call_relay_topic_status_callback_urlstring or null

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

call_request_urlstring or null

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

call_request_methodenum or null

A string representing the HTTP method to use with call_request_url.

call_fallback_urlstring or null

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

call_fallback_methodenum or null

A string representing the HTTP method to use with call_fallback_url.

call_status_callback_urlstring or null

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

call_status_callback_methodenum or null

A string representing the HTTP method to use with call_status_callback_url.

call_laml_application_idstring or null

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

call_video_room_idstring or nullformat: "uuid"

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

call_relay_script_urlstring or null

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

encryptionenum

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

codecslist of strings

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

cipherslist of strings

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.

call_relay_contextstring or nullDeprecated

Deprecated. Use call_relay_application instead.

call_relay_context_status_callback_urlstring or nullDeprecated

Deprecated. Use call_relay_topic_status_callback_url instead.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://{your_space_name}.signalwire.com/api/relay/rest/domain_applications \
>	-H "Content-Type: application/json" \
>	-u "<project_id>:<api_token>" \
>	-d '{
>	"name": "Test App",
>	"identifier": "string"
>	}'

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"type": "domain_application",
4	"domain": "your-space-test_id",
5	"name": "Test App",
6	"identifier": "string",
7	"user": "helpdesk",
8	"ip_auth_enabled": true,
9	"ip_auth": [
10	"string"
11	],
12	"call_handler": "relay_topic",
13	"calling_handler_resource_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
14	"call_relay_topic": "office",
15	"call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
16	"call_request_url": "https://example.com/laml",
17	"call_request_method": "GET",
18	"call_fallback_url": "https://example.com/fallback",
19	"call_fallback_method": "GET",
20	"call_status_callback_url": "https://example.com/status",
21	"call_status_callback_method": "GET",
22	"call_laml_application_id": "app-123456",
23	"call_video_room_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
24	"call_relay_script_url": "https://example.com/relay-script",
25	"encryption": "required",
26	"codecs": [
27	"string"
28	],
29	"ciphers": [
30	"string"
31	],
32	"call_relay_context": "office",
33	"call_relay_context_status_callback_url": "string"
34	}