Domain Aliases

The Cloudonix domain alias model is used to attach named aliases to a domain, similar to how a CNAME record works in the DNS system. This feature is useful for two different usages:

Automatic Inbound Trunking

When a call is received by the Cloudonix Platform - from a remote system - if the call's To SIP address matches any of the domain's aliases - the call will be accepted as a valid inbound trunk call. This handling of incoming calls is much easier to set up then standard inbound trunks - and is therefor the preferred way to setup handling of incoming calls.

Supporting simple SIP softphone applications (such as on smartphones)

SIP Subscriber softphone software can be configured to access the multi-tenant Clouodnix Platform by setting the SIP gateway (sometimes called SIP proxy) address to sip.cloudonix.io, and additionally the software should be set with the customer's domain name as the "SIP domain" for the subscriber. Some simpler softphone software do not have a distinct setting for the "SIP domain" and use the SIP gateway address as the subscriber's domain - so in order to support such software, the customer may create a CNAME - on their DNS service - that points to sip.cloudonix.io, then add that CNAME as a domain alias for their Cloudonix application domain, and then they can set the softphone software to use that CNAME as the gateway address - Cloudonix can then automatically identify and correctly route call from the SIP subscriber.

API Reference

Base Path /customers/self/domains/{domain-id}/aliases[/{alias}]

Properties

Property	Type	Editable	Description
alias	String	Create	The DNS name of this alias.
active	Boolean	Create, Update	Whether this alias is active.
createdAt	ISO-8601 Timestamp	No	When was this alias created.
modifiedAt	ISO-8601 Timestamp	No	When was this alias last modified.
type	subscribers	The type of alias - when created through this API, the type is always subscribers. Other types are used for the Cloudonix Interconnect API.

List Domain Aliases

GET /customers/{customer}/domains/{domain}/aliases

List all domain aliases. Returns an array of Domain Alias JSON model objects.

Example

$ curl 'https://api.cloudonix.io/domains/cloudonix-demo-customer.cloudonix.net/aliases'
  --header 'Authorization: Bearer XI•••••••••••••••'

[
  {
    "alias": "demo.example.com",
    "active": true,
    "type": "subscribers",
    "createdAt": "2024-09-12T20:04:02Z",
    "modifiedAt": "2024-09-12T20:04:02Z",
  }
]

Retrieve a Domain Alias

GET /customers/{customer}/domains/{domain}/aliases/{alias}

Retrieve a specific Domain Alias configuration, by its DNS name. Returns a single Domain Alias JSON model object.

Create a Domain Alias

POST /customers/{customer}/domains/{domain}/aliases

Create a new Domain Alias. Only the alias field is required for creating a new Domain Alias.

$ curl 'https://api.cloudonix.io/customers/self/domains/mydomain.cloudonix.net/aliases' \
  --header 'Authorization: Bearer XI•••••••••••••••' \
  --data-raw '{ "alias":"demo.example.com" }'

{
  "alias": "demo.example.com",
  "active": true,
  "type": "subscribers",
  "createdAt": "2024-09-12T20:04:02Z",
  "modifiedAt": "2024-09-12T20:04:02Z",
}