List connected phones

GET/api/v1/domains/{domain_uuid}/registrations

View registered phones and calling apps for your company.

Path parameters

domain_uuidstringrequired

Your company ID supplied by Junction Cloud Connections. Use the same ID throughout your requests.

Query parameters

limitinteger

Optional. Number of results to return (min 1, max 100). Defaults to 50.

starting_afterstring

Optional. Return results after this registration call-id in the current snapshot.

searchstring

Optional. Search IP, agent, transport, profile, auth user, or auth realm.

sortstring

Optional. Sort field. One of: sip_auth_user, sip_auth_realm, agent, lan_ip, wan_ip, port, status, expsecs, ping_time, sip_profile_name. Defaults to sip_auth_user.

orderstring

Optional. Sort direction: asc or desc. Defaults to asc.

Responses

200Success

objectstring

urlstring

has_moreboolean

dataarray[object]

Show nested fields

call_idstring

objectstring

domain_uuidstring

userstring

agentstring

lan_ipstring

wan_ipstring

portstring

statusstring

expsecsstring

ping_timestring

sip_profile_namestring

400Invalid domain UUID

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

404Domain not found

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

REQUEST EXAMPLE

Replace the host, token and example IDs with your account details.

curl --request GET \
  --url "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/registrations?limit=25" \
  --header "Authorization: Bearer $JUNCTIONCC_API_TOKEN" \
  --header "Accept: application/json"

const token = process.env.JUNCTIONCC_API_TOKEN;

const response = await fetch("https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/registrations?limit=25", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`,
    Accept: "application/json"
  }
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const text = await response.text();
console.log(text ? JSON.parse(text) : null);

import json
import os
from urllib.request import Request, urlopen

request = Request(
    "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/registrations?limit=25",
    method="GET",
    headers={
        "Authorization": "Bearer " + os.environ["JUNCTIONCC_API_TOKEN"],
        "Accept": "application/json"
    }
)
with urlopen(request, timeout=30) as response:
    body = response.read()
    print(json.loads(body) if body else None)

RESPONSE EXAMPLE

{
  "object": "list",
  "url": "/api/v1/domains/4018f7a3-8e0a-47bb-9f4f-04b1313e0e1b/registrations",
  "has_more": false,
  "data": [
    {
      "call_id": "8434b4e1-4f5d-4a85-9cab-2f31a8cb7010",
      "object": "registration",
      "domain_uuid": "4018f7a3-8e0a-47bb-9f4f-04b1313e0e1b",
      "user": "101@pbx.example.com",
      "agent": "Yealink SIP-T46U 108.86.0.20",
      "lan_ip": "192.0.2.10",
      "wan_ip": "203.0.113.42",
      "port": "5060",
      "status": "Registered",
      "expsecs": "3600",
      "ping_time": "18",
      "sip_profile_name": "internal"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid domain UUID.",
    "code": "invalid_request",
    "param": "domain_uuid"
  }
}

{
  "error": {
    "type": "authentication_error",
    "message": "Unauthenticated.",
    "code": "unauthenticated"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Domain not found.",
    "code": "resource_missing",
    "param": "domain_uuid"
  }
}