REST ClientFabricResources

assignDomainApplication

View as MarkdownOpen in Claude

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.
Allowed values:
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.
Allowed values:
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.
Allowed values:
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.
Allowed values:
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
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}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const result = await client.fabric.resources.assignDomainApplication("resource-id", {
10  domain_application_id: "app-uuid"
11});
12console.log(`Domain application assigned: ${result.id}`);