Space Domain Applications

List domain applications

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.

get/api/relay/rest/domain_applications

Query parameters

filter_domainstring

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

filter_namestring

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

page_numberinteger

The page number to retrieve (0-indexed).

page_sizeinteger

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

page_tokenstring

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

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "type": "domain_application",
      "domain": "your-space-test_id",
      "name": "Test App",
      "user": "helpdesk",
      "ip_auth_enabled": true,
      "call_relay_topic": "office",
      "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
      "call_relay_context": "office",
      "call_request_url": "https://example.com/laml",
      "call_fallback_url": "https://example.com/fallback",
      "call_status_callback_url": "https://example.com/status",
      "call_laml_application_id": "app-123456",
      "call_relay_script_url": "https://example.com/relay-script",
      "encryption": "required"
    }
  ]
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.