---
title: "Retrieve a ring group"
method: GET
path: "/ring_groups/{id}"
tags: ["Ring Group"]
---

# Retrieve a ring group

`GET /ring_groups/{id}`

Retrieve ring group by ID.

## Path parameters

- `id` string, required — The unique ID of the resource.

## Response `200`

OK

- object
  - `id` string — The unique ID of the resource.
  - `name` string — The name of ring group.
  - `extension_number` string — The extension number.
  - `ring_time` integer — Duration that each extension will ring, in seconds.
  - `ring_strategy` 'RING_SIMULTANEOUSLY' | 'PRIORITIZED_HUNT' | 'CYCLIC_HUNT' | 'LEAST_WORKED_HUNT' | 'PAGING_INTERCOM' | 'SKILL_BASED_ROUTING_PRIORITIZED_HUNT' | 'SKILL_BASED_ROUTING_CYCLIC_HUNT' | 'SKILL_BASED_ROUTING_LEAST_WORKED_HUNT' — Ring strategy: Can be either: - `RING_SIMULTANEOUSLY`: Ring all available members of the group simultaneously. - `PRIORITIZED_HUNT`: Ring each available member of the group serially in the configured order. - `CYCLIC_HUNT`: Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first. - `LEAST_WORKED_HUNT`: Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first. - `PAGING_INTERCOM`: Ring all available members of the group simultaneously and add an auto answer indication to the calls in order to invoke a page. - `SKILL_BASED_ROUTING_PRIORITIZED_HUNT`: The call assign to the agents in the level "1" skill group first, and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group. Ring each available member of the group serially in the configured order. - `SKILL_BASED_ROUTING_CYCLIC_HUNT`: The call assign to the agents in the level "1" skill group first, and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group. Ring each available member of the group serially, ring the member that hasn't been rung from a call from this group in the longest amount of time first. - `SKILL_BASED_ROUTING_LEAST_WORKED_HUNT`: The call assign to the agents in the level "1" skill group first, and move on to the less experienced agents in subsequent skill groups, if the call is not answered in current skill group. Ring each available member of the group serially, ring the member that hasn't answered a call from this group in the longest amount of time first.
  - `skip_busy_member` boolean — Indicates if members on call would be skipped.
  - `enable_paid` boolean — Whether to add ring group information into `P-Asserted-Identity` header.
  - `enable_prid` boolean — Whether to add ring group information into `Remote-Party-ID` header.
  - `extension_number_as_to_header` boolean — Whether to user extension number as invite `To` header.
  - `no_answer_forward_rule` object
    - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'REPEAT' | 'HANGUP' — Forward actions includes: - `FORWARD_TO_NUMBER`: - `FORWARD_TO_VOICEMAIL`: - `REPEAT`: - `HANGUP`:
    - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning.
  - `outbound_caller_ids` object[] — A collection of outbound caller IDs.
    - `provider_id` string — The unique ID of the resource.
    - `caller_id` string — Outbound caller id.
    - `description` string — The descriptive information about this outbound caller id.

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)