Retrieve phone number

GET/api/v1/domains/{domain_uuid}/phone-numbers/{destination_uuid}

Retrieve the configuration of one phone number.

Path parameters

domain_uuidstringrequired

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

destination_uuidstringrequired

The destination UUID.

Responses

200Success

destination_uuidstring

objectstring

domain_uuidstring

destination_numberstring

destination_prefixstring

destination_enabledboolean

destination_descriptionstring

fax_uuidstring

destination_recordboolean

destination_type_faxstring

destination_hold_musicstring

destination_distinctive_ringstring

destination_cid_name_prefixstring

destination_accountcodestring

routing_optionsarray[object]

Show nested fields

typestring

extensionstring

optionstring

namestring

400Invalid destination UUID

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

403The request is not available for this account.

404Phone number 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/phone-numbers/ad45f53d-405b-48bc-aac2-d51b2b3b3e55" \
  --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-numbers/ad45f53d-405b-48bc-aac2-d51b2b3b3e55", {
  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-numbers/ad45f53d-405b-48bc-aac2-d51b2b3b3e55",
    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

{
  "destination_uuid": "ad45f53d-405b-48bc-aac2-d51b2b3b3e55",
  "object": "phone_number",
  "domain_uuid": "7d58342b-2b29-4dcf-92d6-e9a9e002a4e5",
  "destination_number": "2137577900",
  "destination_prefix": "1",
  "destination_enabled": true,
  "destination_description": null,
  "fax_uuid": null,
  "destination_record": true,
  "destination_type_fax": null,
  "destination_hold_music": null,
  "destination_distinctive_ring": null,
  "destination_cid_name_prefix": null,
  "destination_accountcode": null,
  "routing_options": [
    {
      "type": "extensions",
      "extension": "100",
      "option": "2304420c-9ec2-469c-a7d0-f671a6176f36",
      "name": "100 - Alice Johnson"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid destination UUID.",
    "code": "invalid_request",
    "param": "destination_uuid"
  }
}

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

{
  "error": {
    "type": "invalid_request_error",
    "message": "Phone number not found.",
    "code": "resource_missing",
    "param": "destination_uuid"
  }
}