Retrieve a connection

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

Retrieve one phone or app registration.

Path parameters

domain_uuidstringrequired

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

call_idstringrequired

The registration call-id.

Responses

200Success

call_idstring

objectstring

domain_uuidstring

userstring

statusstring

lan_ipstring

portstring

contactstring

agentstring

transportstring

wan_ipstring

sip_profile_namestring

sip_auth_userstring

sip_auth_realmstring

ping_timestring

expsecsstring

400Invalid domain UUID

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

404Registration 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/8434b4e1-4f5d-4a85-9cab-2f31a8cb7010" \
  --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/8434b4e1-4f5d-4a85-9cab-2f31a8cb7010", {
  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/8434b4e1-4f5d-4a85-9cab-2f31a8cb7010",
    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

{
  "call_id": "8434b4e1-4f5d-4a85-9cab-2f31a8cb7010",
  "object": "registration",
  "domain_uuid": "4018f7a3-8e0a-47bb-9f4f-04b1313e0e1b",
  "user": "101@pbx.example.com",
  "status": "Registered",
  "lan_ip": "192.0.2.10",
  "port": "5060",
  "contact": "sip:101@192.0.2.10:5060;transport=udp",
  "agent": "Yealink SIP-T46U 108.86.0.20",
  "transport": "UDP",
  "wan_ip": "203.0.113.42",
  "sip_profile_name": "internal",
  "sip_auth_user": "101",
  "sip_auth_realm": "pbx.example.com",
  "ping_time": "18",
  "expsecs": "3600"
}

{
  "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": "Registration not found.",
    "code": "resource_missing",
    "param": "call_id"
  }
}