Ring groups

List ring groups.

Retrieve a collection of ring groups.

GEThttp://127.0.0.1:8888/api/ring_groups

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ring_groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "extension_number": "text",
      "ring_strategy": "RING_SIMULTANEOUSLY"
    }
  ]
}

Create a ring group

Add a new ring group.

POSThttp://127.0.0.1:8888/api/ring_groups

Body

application/json

namestring

The name of ring group.

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

ring_timeinteger (int32)

Duration that each extension will ring, in seconds.

ring_strategyenum

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.

RING_SIMULTANEOUSLYPRIORITIZED_HUNTCYCLIC_HUNTLEAST_WORKED_HUNTPAGING_INTERCOMSKILL_BASED_ROUTING_PRIORITIZED_HUNTSKILL_BASED_ROUTING_CYCLIC_HUNTSKILL_BASED_ROUTING_LEAST_WORKED_HUNT

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.

no_answer_forward_ruleobject

outbound_caller_idsarray of object

A collection of outbound caller IDs.

Response

2004XX

Created ring group

Body

application/json

idall of

The unique ID of ring group.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ring_groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": {}
}

Retrieve a ring group

Retrieve ring group by ID.

GEThttp://127.0.0.1:8888/api/ring_groups/{id}

Path parameters

id*all of

The unique ID of ring group.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of ring group.

namestring

The name of ring group.

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

ring_timeinteger (int32)

Duration that each extension will ring, in seconds.

ring_strategyenum

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.

RING_SIMULTANEOUSLYPRIORITIZED_HUNTCYCLIC_HUNTLEAST_WORKED_HUNTPAGING_INTERCOMSKILL_BASED_ROUTING_PRIORITIZED_HUNTSKILL_BASED_ROUTING_CYCLIC_HUNTSKILL_BASED_ROUTING_LEAST_WORKED_HUNT

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.

no_answer_forward_ruleobject

outbound_caller_idsarray of object

A collection of outbound caller IDs.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ring_groups/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "name": "text",
  "extension_number": "text",
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": false,
  "enable_paid": true,
  "enable_prid": true,
  "extension_number_as_to_header": false,
  "no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "outbound_caller_ids": [
    {
      "provider_id": {},
      "caller_id": {},
      "description": "text"
    }
  ]
}

Update a ring group

Update a ring group

POSThttp://127.0.0.1:8888/api/ring_groups/{id}

Path parameters

id*all of

The unique ID of ring group.

Body

application/json

namestring

The name of ring group.

ring_timeinteger (int32)

Duration that each extension will ring, in seconds.

ring_strategyenum

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.

RING_SIMULTANEOUSLYPRIORITIZED_HUNTCYCLIC_HUNTLEAST_WORKED_HUNTPAGING_INTERCOMSKILL_BASED_ROUTING_PRIORITIZED_HUNTSKILL_BASED_ROUTING_CYCLIC_HUNTSKILL_BASED_ROUTING_LEAST_WORKED_HUNT

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.

no_answer_forward_ruleobject

outbound_caller_idsarray of object

A collection of outbound caller IDs.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ring_groups/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();