Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Ring Group

Retrieve a ring group

Retrieve ring group by ID.

get/ring_groups/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the ring group.

Response

OK

idstring

The unique ID of the resource.

namestring

The name of ring group.

extension_numberstring

The extension number.

ring_timeinteger

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_memberboolean

Indicates if members on call would be skipped.

enable_paidboolean

Whether to add ring group information into P-Asserted-Identity header.

enable_pridboolean

Whether to add ring group information into Remote-Party-ID header.

extension_number_as_to_headerboolean

Whether to user extension number as invite To header.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}