# Create a Domain Application

POST https://YOUR_SPACE.signalwire.com/api/relay/rest/domain_applications
Content-Type: application/json

Creates a new 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).

Reference: https://signalwire.com/docs/apis/relay-rest/domain-applications/create-domain-application

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /domain_applications:
    post:
      operationId: create-domain-application
      summary: Create a Domain Application
      description: >-
        Creates a new 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).
      tags:
        - subpackage_domainApplications
      parameters:
        - name: Authorization
          in: header
          description: >-
            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)

            ```
          required: true
          schema:
            type: string
      responses:
        '201':
          description: >-
            The request has succeeded and a new resource has been created as a
            result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainApplicationResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainApplicationRequest'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    CreateDomainApplicationRequestEncryption:
      type: string
      enum:
        - optional
        - required
        - forbidden
      default: optional
      description: >-
        Whether connections to this domain application require encryption or if
        encryption is optional.
      title: CreateDomainApplicationRequestEncryption
    DomainAppCallHandlerRequest:
      type: string
      enum:
        - relay_topic
        - relay_application
        - laml_webhooks
        - laml_application
        - video_room
        - relay_script
        - dialogflow
        - ai_agent
        - call_flow
        - relay_context
      description: Call handler types that can be assigned via the API.
      title: DomainAppCallHandlerRequest
    CreateDomainApplicationRequestCallRequestMethod:
      type: string
      enum:
        - GET
        - POST
      default: POST
      description: A string representing the HTTP method to use with call_request_url.
      title: CreateDomainApplicationRequestCallRequestMethod
    CreateDomainApplicationRequestCallFallbackMethod:
      type: string
      enum:
        - GET
        - POST
      default: POST
      description: A string representing the HTTP method to use with call_fallback_url.
      title: CreateDomainApplicationRequestCallFallbackMethod
    CreateDomainApplicationRequestCallStatusCallbackMethod:
      type: string
      enum:
        - GET
        - POST
      default: POST
      description: >-
        A string representing the HTTP method to use with
        call_status_callback_url.
      title: CreateDomainApplicationRequestCallStatusCallbackMethod
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    CreateDomainApplicationRequestCallFlowVersion:
      type: string
      enum:
        - working_copy
        - current_deployed
      description: A string representing the version of your Call Flow you'd like to use.
      title: CreateDomainApplicationRequestCallFlowVersion
    CreateDomainApplicationRequest:
      type: object
      properties:
        name:
          type: string
          description: A string representing the friendly name for this domain application.
        identifier:
          type: string
          description: >-
            A string representing the identifier portion of the domain
            application.
        user:
          type: string
          default: '*'
          description: The user portion of the domain application.
        ip_auth_enabled:
          type: boolean
          description: >-
            Whether the domain application will enforce IP authentication for
            incoming requests.
        ip_auth:
          type: array
          items:
            type: string
          description: >-
            A list containing whitelisted IP addresses and IP blocks used if
            ip_auth_enabled is true.
        encryption:
          $ref: '#/components/schemas/CreateDomainApplicationRequestEncryption'
          description: >-
            Whether connections to this domain application require encryption or
            if encryption is optional.
        codecs:
          type: array
          items:
            type: string
          description: A list of codecs this domain application will support.
        ciphers:
          type: array
          items:
            type: string
          description: A list of encryption ciphers this domain application will support.
        call_handler:
          $ref: '#/components/schemas/DomainAppCallHandlerRequest'
          description: Specify how the domain application will handle calls.
        call_relay_topic:
          type: string
          description: >-
            A string representing the Relay topic to forward incoming calls to.
            Required when call_handler is relay_topic.
        call_relay_topic_status_callback_url:
          type: string
          description: A string representing a URL to send status change messages to.
        call_relay_application:
          type: string
          description: >-
            A string representing the Relay Application to forward incoming
            calls to. Required when call_handler is relay_application.
        call_request_url:
          type: string
          description: >-
            A string representing the LaML URL to access when a call is
            received. Required when call_handler is laml_webhooks.
        call_request_method:
          $ref: '#/components/schemas/CreateDomainApplicationRequestCallRequestMethod'
          description: A string representing the HTTP method to use with call_request_url.
        call_fallback_url:
          type: string
          description: >-
            A string representing the LaML URL to access when the call to
            call_request_url fails.
        call_fallback_method:
          $ref: >-
            #/components/schemas/CreateDomainApplicationRequestCallFallbackMethod
          description: A string representing the HTTP method to use with call_fallback_url.
        call_status_callback_url:
          type: string
          description: A string representing a URL to send status change messages to.
        call_status_callback_method:
          $ref: >-
            #/components/schemas/CreateDomainApplicationRequestCallStatusCallbackMethod
          description: >-
            A string representing the HTTP method to use with
            call_status_callback_url.
        call_laml_application_id:
          type: string
          description: >-
            A string representing the ID of the LaML application to forward
            incoming calls to. Required when call_handler is laml_application.
        call_video_room_id:
          $ref: '#/components/schemas/uuid'
          description: >-
            A string representing the ID of the Video Room to forward incoming
            calls to. Required when call_handler is video_room.
        call_relay_script_url:
          type: string
          description: >-
            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_id:
          $ref: '#/components/schemas/uuid'
          description: >-
            A string representing the ID of the Dialogflow Agent to forward
            incoming calls to. Required when call_handler is dialogflow.
        call_ai_agent_id:
          $ref: '#/components/schemas/uuid'
          description: >-
            A string representing the ID of the AI Agent to forward incoming
            calls to. Required when call_handler is ai_agent.
        call_flow_id:
          $ref: '#/components/schemas/uuid'
          description: >-
            A string representing the ID of the Call Flow to forward incoming
            calls to. Required when call_handler is call_flow.
        call_flow_version:
          $ref: '#/components/schemas/CreateDomainApplicationRequestCallFlowVersion'
          description: >-
            A string representing the version of your Call Flow you'd like to
            use.
        call_relay_context:
          type: string
          description: >-
            This handler type is deprecated. Please use call_relay_application
            or call_relay_topic instead.
        call_relay_context_status_callback_url:
          type: string
          description: >-
            This property is deprecated. Please use
            call_relay_topic_status_callback_url instead.
      required:
        - name
        - identifier
      description: Request body for creating a domain application.
      title: CreateDomainApplicationRequest
    DomainAppCallHandler:
      type: string
      enum:
        - relay_topic
        - relay_application
        - laml_webhooks
        - laml_application
        - video_room
        - relay_script
        - dialogflow
        - ai_agent
        - call_flow
        - relay_context
        - relay_connector
        - fabric_subscriber
        - sip_gateway
        - call_queue
      description: >-
        All possible call handler types for domain applications. Includes types
        that can only be assigned via the Fabric API or UI.
      title: DomainAppCallHandler
    DomainApplicationResponseCallRequestMethod:
      type: string
      enum:
        - GET
        - POST
      description: A string representing the HTTP method to use with call_request_url.
      title: DomainApplicationResponseCallRequestMethod
    DomainApplicationResponseCallFallbackMethod:
      type: string
      enum:
        - GET
        - POST
      description: A string representing the HTTP method to use with call_fallback_url.
      title: DomainApplicationResponseCallFallbackMethod
    DomainApplicationResponseCallStatusCallbackMethod:
      type: string
      enum:
        - GET
        - POST
      description: >-
        A string representing the HTTP method to use with
        call_status_callback_url.
      title: DomainApplicationResponseCallStatusCallbackMethod
    DomainApplicationResponseEncryption:
      type: string
      enum:
        - optional
        - required
        - forbidden
      description: >-
        A string representing whether connections to this domain application
        require encryption or if encryption is optional. Valid values are
        optional, required, and forbidden.
      title: DomainApplicationResponseEncryption
    DomainApplicationResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the domain application on SignalWire.
        type:
          type: string
          description: A string representation of the type of object this record is.
        domain:
          type: string
          description: >-
            The unique domain for this application, combining your space
            subdomain and identifier.
        name:
          type:
            - string
            - 'null'
          description: A string representing the friendly name for this domain application.
        identifier:
          type: string
          description: >-
            A string representing the identifier portion of the domain
            application.
        user:
          type: string
          description: A string representing the user portion of the domain application.
        ip_auth_enabled:
          type: boolean
          description: >-
            Whether the domain application will enforce IP authentication for
            incoming requests.
        ip_auth:
          type: array
          items:
            type: string
          description: >-
            A list containing whitelisted IP addresses and IP blocks used if
            ip_auth_enabled is true.
        call_handler:
          oneOf:
            - $ref: '#/components/schemas/DomainAppCallHandler'
            - type: 'null'
          description: Specify how the domain application will handle calls.
        calling_handler_resource_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: The unique identifier of the calling handler resource.
        call_relay_topic:
          type:
            - string
            - 'null'
          description: A string representing the Relay topic to forward incoming calls to.
        call_relay_topic_status_callback_url:
          type:
            - string
            - 'null'
          description: A string representing a URL to send status change messages to.
        call_relay_context:
          type:
            - string
            - 'null'
          description: Deprecated. Use call_relay_application instead.
        call_relay_context_status_callback_url:
          type:
            - string
            - 'null'
          description: Deprecated. Use call_relay_topic_status_callback_url instead.
        call_request_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing the LaML URL to access when a call is
            received.
        call_request_method:
          oneOf:
            - $ref: '#/components/schemas/DomainApplicationResponseCallRequestMethod'
            - type: 'null'
          description: A string representing the HTTP method to use with call_request_url.
        call_fallback_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing the LaML URL to access when the call to
            call_request_url fails.
        call_fallback_method:
          oneOf:
            - $ref: '#/components/schemas/DomainApplicationResponseCallFallbackMethod'
            - type: 'null'
          description: A string representing the HTTP method to use with call_fallback_url.
        call_status_callback_url:
          type:
            - string
            - 'null'
          description: A string representing a URL to send status change messages to.
        call_status_callback_method:
          oneOf:
            - $ref: >-
                #/components/schemas/DomainApplicationResponseCallStatusCallbackMethod
            - type: 'null'
          description: >-
            A string representing the HTTP method to use with
            call_status_callback_url.
        call_laml_application_id:
          type:
            - string
            - 'null'
          description: >-
            A string representing the ID of the LaML application to forward
            incoming calls to.
        call_video_room_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            A string representing the ID of the Video Room to forward incoming
            calls to.
        call_relay_script_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing the URL of the Relay script to execute when a
            call is received.
        encryption:
          $ref: '#/components/schemas/DomainApplicationResponseEncryption'
          description: >-
            A string representing whether connections to this domain application
            require encryption or if encryption is optional. Valid values are
            optional, required, and forbidden.
        codecs:
          type: array
          items:
            type: string
          description: >-
            A list of codecs this domain application will support. Currently
            supported values are: OPUS, G722, PCMU, PCMA, G729, VP8, and H264.
        ciphers:
          type: array
          items:
            type: string
          description: >-
            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.
      required:
        - id
        - type
        - domain
        - name
        - identifier
        - user
        - ip_auth_enabled
        - ip_auth
        - call_handler
        - calling_handler_resource_id
        - call_relay_topic
        - call_relay_topic_status_callback_url
        - call_relay_context
        - call_relay_context_status_callback_url
        - call_request_url
        - call_request_method
        - call_fallback_url
        - call_fallback_method
        - call_status_callback_url
        - call_status_callback_method
        - call_laml_application_id
        - call_video_room_id
        - call_relay_script_url
        - encryption
        - codecs
        - ciphers
      description: Response containing a single domain application.
      title: DomainApplicationResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    Types.StatusCodes.SpaceApiErrorItem:
      type: object
      properties:
        detail:
          type: string
          description: A description of what caused the error.
        status:
          type: string
          description: The HTTP status code.
        title:
          type: string
          description: A short summary of the error type.
        code:
          type: string
          description: The error code.
      required:
        - detail
        - status
        - title
        - code
      description: Details about a specific validation error.
      title: Types.StatusCodes.SpaceApiErrorItem
    Types.StatusCodes.ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request failed validation. See errors for details.
      title: Types.StatusCodes.ValidationError
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        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)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/domain_applications"

payload = {
    "name": "Test App",
    "identifier": "string"
}
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/domain_applications';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/json'
  },
  body: '{"name":"Test App","identifier":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/relay/rest/domain_applications"

	payload := strings.NewReader("{\n  \"name\": \"Test App\",\n  \"identifier\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/relay/rest/domain_applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Test App\",\n  \"identifier\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://your_space.signalwire.com/api/relay/rest/domain_applications")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Test App\",\n  \"identifier\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your_space.signalwire.com/api/relay/rest/domain_applications', [
  'body' => '{
  "name": "Test App",
  "identifier": "string"
}',
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/domain_applications");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Test App\",\n  \"identifier\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Basic <project_id>:<api_token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Test App",
  "identifier": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/relay/rest/domain_applications")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```