Get a domain's SIP servers

GET

/domains/{domain}/sip-servers

Last modified:2026-09-29 17:13:16

OperationId:GetDomainSipServers

Where the domain's SIP clients should connect. Replaces the WS_SERVERS UI config (GET /configurations/ws_servers), which is a hand-maintained list and can disagree with where NDP places the domain's phones. This endpoint derives the answer from NDP instead and never reads WS_SERVERS.

How the list is built

The preferred server is the provisioning.preferred-server domain setting (domain, then reseller, then system tier). If none is set, it falls back to the legacy PORTAL_DEVICE_NDP_SERVER UI config (domain row, then PORTAL_DEVICE_NDP_SERVER_<reseller>, then the global row), and then to NsNdpSiPbxServer.

The list is the preferred server plus every other server in its geo group, from NDP's server list (/phones/servers).

The preferred server comes first. The others follow only if they allow backup. When provisioning.redundancy is none, the list holds the preferred server alone.

srv lists _sip._tls, _sip._tcp and _sip._udp names for each server postfix, with the resolved records.

servers is sorted by priority, lowest first. preferred-srv is the one srv entry for the provisioning.preferred-transport domain setting (tls, tcp or udp). If that is unset, the legacy PORTAL_INVENTORY_PHONES_TRANSPORT_TYPE UI config is used when it holds one of those values; otherwise tls, under the postfix of the first server that has one. It is null when no server has a postfix.

Servers are not sorted by distance. NDP sorts a phone's servers by the phone's location, and the API has no location for a browser.

The answer is cached for up to 5 minutes. A domain setting change or an NDP server change clears the cache on servers that receive the event. A change to a legacy UI config does not, so it can take up to 5 minutes to show.

Every scope can read its own domain.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

The servers to connect to, in order

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/acme.example.com/sip-servers' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success Example

{
    "domain": "acme.example.com",
    "preferred-server": "core1",
    "preferred-server-source": "domain",
    "redundancy": "geography",
    "redundancy-group": "east",
    "preferred-transport": "tls",
    "preferred-transport-source": "domain",
    "srv": [
        {
            "name": "_sip._tls.east.example.com",
            "transport": "tls",
            "records": [
                {
                    "target": "core1.example.com",
                    "port": 5061,
                    "priority": 10,
                    "weight": 50
                }
            ]
        },
        {
            "name": "_sip._tcp.east.example.com",
            "transport": "tcp",
            "records": []
        },
        {
            "name": "_sip._udp.east.example.com",
            "transport": "udp",
            "records": []
        }
    ],
    "preferred-srv": {
        "name": "_sip._tls.east.example.com",
        "transport": "tls",
        "records": [
            {
                "target": "core1.example.com",
                "port": 5061,
                "priority": 10,
                "weight": 50
            }
        ]
    },
    "servers": [
        {
            "name": "core1",
            "hostname": "core1.example.com",
            "priority": 1,
            "weight": 100,
            "wss-uri": "wss://core1.example.com:9002",
            "sip-port": 5060,
            "sip-port-tcp": 5060,
            "sip-port-tls": 5061,
            "location": "Ashburn",
            "backup-allowed": "yes",
            "status": "online"
        },
        {
            "name": "core2",
            "hostname": "core2.example.com",
            "priority": 2,
            "weight": 90,
            "wss-uri": "wss://core2.example.com:9002",
            "sip-port": 5060,
            "sip-port-tcp": null,
            "sip-port-tls": null,
            "location": null,
            "backup-allowed": "yes",
            "status": null
        }
    ]
}

Modified at 2026-09-29 17:13:16

Check if Domain Exists

Get Users in Domain