assignDomainApplication

Assign a domain application to a Fabric resource.

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the domain application.

Request

domain_application_idstringRequiredformat: "uuid"

The id of the domain application you wish to assign a resource to.

Response

idstringRequiredformat: "uuid"

The unique identifier of the domain application on SignalWire.

typestringRequired

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

domainstringRequired

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

namestring or nullRequired

A string representing the friendly name for this domain application.

identifierstringRequired

A string representing the identifier portion of the domain application.

userstringRequired

A string representing the user portion of the domain application.

ip_auth_enabledbooleanRequired

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

ip_authlist of stringsRequired

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

call_handlerenum or nullRequired

Specify how the domain application will handle calls.

calling_handler_resource_idstring or nullRequiredformat: "uuid"

The unique identifier of the calling handler resource.

call_relay_topicstring or nullRequired

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

call_relay_topic_status_callback_urlstring or nullRequired

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

call_request_urlstring or nullRequired

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

call_request_methodenum or nullRequired

A string representing the HTTP method to use with call_request_url.

call_fallback_urlstring or nullRequired

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

call_fallback_methodenum or nullRequired

A string representing the HTTP method to use with call_fallback_url.

call_status_callback_urlstring or nullRequired

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

call_status_callback_methodenum or nullRequired

A string representing the HTTP method to use with call_status_callback_url.

call_laml_application_idstring or nullRequired

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

call_video_room_idstring or nullRequiredformat: "uuid"

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

call_relay_script_urlstring or nullRequired

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

encryptionenumRequired

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 stringsRequired

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

cipherslist of stringsRequired

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 nullRequiredDeprecated

Deprecated. Use call_relay_application instead.

call_relay_context_status_callback_urlstring or nullRequiredDeprecated

Deprecated. Use call_relay_topic_status_callback_url instead.

Response Example

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "domain_application",
  "domain": "your-space-test_id",
  "name": "Test App",
  "identifier": "string",
  "user": "helpdesk",
  "ip_auth_enabled": true,
  "ip_auth": [
    "string"
  ],
  "call_handler": "relay_topic",
  "calling_handler_resource_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
  "call_relay_topic": "office",
  "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
  "call_request_url": "https://example.com/laml",
  "call_request_method": "GET",
  "call_fallback_url": "https://example.com/fallback",
  "call_fallback_method": "GET",
  "call_status_callback_url": "https://example.com/status",
  "call_status_callback_method": "GET",
  "call_laml_application_id": "app-123456",
  "call_video_room_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
  "call_relay_script_url": "https://example.com/relay-script",
  "encryption": "required",
  "codecs": [
    "string"
  ],
  "ciphers": [
    "string"
  ],
  "call_relay_context": "office",
  "call_relay_context_status_callback_url": "string"
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const result = await client.fabric.resources.assignDomainApplication("resource-id", {
  domain_application_id: "app-uuid"
});
console.log(`Domain application assigned: ${result.id}`);