List domain applications

GET

https://{your_space_name}.signalwire.com/api/relay/rest/domain_applications

GET

/api/relay/rest/domain_applications

curl https://{your_space_name}.signalwire.com/api/relay/rest/domain_applications \
     -u "<project_id>:<api_token>"

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "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"
    }
  ]
}

Lists the SIP Domain Applications in your SignalWire project. A Domain Application gives inbound SIP traffic a project-specific domain and routes its calls to a configured handler. Use Assign domain application handler when that handler is an existing Fabric resource. Results are sorted by creation date, most recent first.

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.

Lists the SIP Domain Applications in your SignalWire project. A Domain Application gives inbound SIP traffic a project-specific domain and routes its calls to a configured handler. Use [Assign domain application handler](/docs/apis/rest/domain-applications/assign-resource-domain-application) when that handler is an existing Fabric resource. Results are sorted by creation date, most recent first. #### 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) ```

Query parameters

filter_domainstringOptional

String representing the domain portion of the domain application. Will return all domain applications containing this value as a substring.

filter_namestringOptional

String representing the name portion of the domain application. Will return all domain applications containing this value as a substring.

page_numberintegerOptionalDefaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

The number of items per page (1-1000).

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number > 0.

Response

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of domain applications.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error