Retrieve a ring group

GET/api/v1/domains/{domain_uuid}/ring-groups/{ring_group_uuid}

Retrieve a ring group and its configured destinations.

Path parameters

domain_uuidstringrequired

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

ring_group_uuidstringrequired

The ring group UUID.

Responses

200Success

ring_group_uuidstring

objectstring

domain_uuidstring

ring_group_namestring

ring_group_extensionstring

ring_group_greetingstring

ring_group_caller_id_namestring

ring_group_caller_id_numberstring

ring_group_cid_name_prefixstring

ring_group_cid_number_prefixstring

ring_group_strategystring

timeout_actionstring

timeout_targetstring

ring_group_call_forward_enabledboolean

ring_group_follow_me_enabledboolean

ring_group_descriptionstring

ring_group_forward_enabledboolean

forward_actionstring

forward_targetstring

ring_group_enabledboolean

membersarray[object]

Show nested fields

ring_group_destination_uuidstring

ring_group_uuidstring

destination_numberstring

destination_enabledboolean

destination_delayinteger

destination_timeoutinteger

destination_promptboolean

400Invalid ring group UUID

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

404Ring group 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/ring-groups/40aec3e8-a572-40da-954b-ddf6a8a65324" \
  --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/ring-groups/40aec3e8-a572-40da-954b-ddf6a8a65324", {
  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/ring-groups/40aec3e8-a572-40da-954b-ddf6a8a65324",
    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

{
  "ring_group_uuid": "40aec3e8-a572-40da-954b-ddf6a8a65324",
  "object": "ring_group",
  "domain_uuid": "7d58342b-2b29-4dcf-92d6-e9a9e002a4e5",
  "ring_group_name": "Seattle Main Group",
  "ring_group_extension": "0",
  "ring_group_greeting": null,
  "ring_group_caller_id_name": null,
  "ring_group_caller_id_number": null,
  "ring_group_cid_name_prefix": null,
  "ring_group_cid_number_prefix": null,
  "ring_group_strategy": "sequence",
  "timeout_action": "voicemails",
  "timeout_target": "101",
  "ring_group_call_forward_enabled": true,
  "ring_group_follow_me_enabled": true,
  "ring_group_description": null,
  "ring_group_forward_enabled": false,
  "forward_action": "external",
  "forward_target": "456",
  "ring_group_enabled": true,
  "members": [
    {
      "ring_group_destination_uuid": "4ec29bfd-9f4b-4a4c-b934-0015412711c9",
      "ring_group_uuid": "40aec3e8-a572-40da-954b-ddf6a8a65324",
      "destination_number": "100",
      "destination_enabled": true,
      "destination_delay": 0,
      "destination_timeout": 25,
      "destination_prompt": false
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid ring group UUID.",
    "code": "invalid_request",
    "param": "ring_group_uuid"
  }
}

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

{
  "error": {
    "type": "invalid_request_error",
    "message": "Ring group not found.",
    "code": "resource_missing",
    "param": "ring_group_uuid"
  }
}