Ring groups

List ring groups.

get

Retrieve a collection of ring groups.

Authorizations
Query parameters
filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100
Responses
200
OK
application/json
get
GET /api/ring_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a ring group

post

Add a new ring group.

Authorizations
Body
namestring · min: 1 · max: 64Optional

The name of ring group.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

Duration that each extension will ring, in seconds.

Default: 20
ring_strategystring · enumOptional

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.
Possible values:
skip_busy_memberbooleanOptional

Indicates if members on call would be skipped.

enable_paidbooleanOptional

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

Default: true
enable_pridbooleanOptional

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

Default: true
extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false
Responses
200
Created ring group
application/json
post
POST /api/ring_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "name": "text",
  "extension_number": "text",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "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": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ]
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a ring group

get

Retrieve ring group by ID.

Authorizations
Path parameters
idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/ring_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "extension_number": "text",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "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": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ]
}

Update a ring group

post

Update a ring group

Authorizations
Path parameters
idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
namestring · min: 1 · max: 64Optional

The name of ring group.

ring_timeinteger · int32Optional

Duration that each extension will ring, in seconds.

Default: 20
ring_strategystring · enumOptional

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.
Possible values:
skip_busy_memberbooleanOptional

Indicates if members on call would be skipped.

enable_paidbooleanOptional

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

Default: true
enable_pridbooleanOptional

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

Default: true
extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false
Responses
200
OK
post
POST /api/ring_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 347

{
  "name": "text",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "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": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ]
}
No content
PreviousDestroyNextAgents