Find phones for call control

GET/api/v1/domains/{domain_uuid}/phone-control/targets

Find connected phones you can use for click-to-dial and call control. Select a specific phone with its agent value and check supported_actions before sending a command.

Path parameters

domain_uuidstringrequired

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

Query parameters

extensionstringrequired

Extension number to inspect.

Responses

200Success

objectstring

urlstring

has_moreboolean

dataarray[object]

Show nested fields

vendorstring

agentstring

lan_ipstring

registration_countinteger

registration_call_idsarray[string]

supported_actionsarray[string]

400Validation error

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

403The request is not available for this account.

404Extension not found

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

500Internal server error

errorobject

Show nested fields

typestring

messagestring

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/phone-control/targets?extension=1001" \
  --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/phone-control/targets?extension=1001", {
  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/phone-control/targets?extension=1001",
    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/phone-control/targets",
  "has_more": false,
  "data": [
    {
      "vendor": "yealink",
      "agent": "Yealink SIP-T53W 96.86.0.45",
      "lan_ip": "10.0.0.25",
      "registration_count": 1,
      "registration_call_ids": [
        "8cc81337-3728-4b87-a507-f59627abf313"
      ],
      "supported_actions": [
        "hold",
        "resume",
        "blind-transfer",
        "attended-transfer",
        "complete-transfer",
        "cancel-transfer",
        "conference",
        "mute-toggle",
        "end-call",
        "answer-call",
        "dnd-on",
        "dnd-off"
      ]
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The extension field is required.",
    "code": "invalid_parameter",
    "param": "extension"
  }
}

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

{
  "error": {
    "type": "invalid_request_error",
    "message": "Extension not found.",
    "code": "resource_missing",
    "param": "extension"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "An unexpected error occurred."
  }
}