Hunt Group

One destination that rings a set of Identities.

app.onsim.uk/team/hunt-groups/300

Supportlabel

300extension

All at onceringing_strategy

members

Fields

Field	Type	What it is	On app.onsim
id	integer	The ID of the Hunt Group. It does not change when the extension does.	Not shown.
extension	string	What others dial to reach it. It can change.	The line under the name. It is also in the address of the page.
label	string	The label of the extension, as app.onsim and the call records show it. It is not the name of a person.	The name beside the mark.
ringing_strategyoptional	"order" | "random" | "simultaneous" | "least_used"	The order in which the Hunt Group rings its members.	The Ringing column: In order, Random, All at once or Least used.
caller_idoptional	"caller" | "caller_number" | "group"	What a member sees when the Hunt Group rings them. caller: the number and the name of the caller. caller_number: the number of the caller and the name of the Hunt Group. group: the number and the name of the Hunt Group.	Not shown.
pickup_allowedoptional	boolean	True when another extension can pick up a call that rings a member.	Not shown.
members	list of HuntGroupMember	The extensions that the Hunt Group rings.	The avatars in the Users column. A member that the group does not ring is faint.

A member

A member is an extension that the Hunt Group rings: that of a User, of an IVR or of another Hunt Group. Each of those has the same extension field.

Field	Type	What it is
extension	string	The extension that the Hunt Group rings: that of a User, of an IVR or of another Hunt Group.
active	boolean	False when the Hunt Group does not ring this member.
positionoptional	integer	The place of the member in the order of ringing. Members can share a place.
ring_delayoptional	integer	The seconds before the member starts to ring.
ring_timeoptional	integer	The seconds that the member rings.
forwarding	boolean	True when the call forwarding of the member applies to a call from the Hunt Group.

Example

{
  "id": 1060,
  "extension": "300",
  "label": "Support",
  "ringing_strategy": "simultaneous",
  "caller_id": "caller_number",
  "pickup_allowed": true,
  "members": [
    {
      "extension": "500",
      "active": true,
      "position": 1,
      "ring_delay": 0,
      "ring_time": 30,
      "forwarding": false
    },
    {
      "extension": "301",
      "active": true,
      "position": 2,
      "ring_delay": 20,
      "ring_time": 30,
      "forwarding": false
    },
    {
      "extension": "201",
      "active": true,
      "position": 3,
      "ring_delay": 40,
      "ring_time": 30,
      "forwarding": false
    }
  ]
}

Methods

The list gives each one with id, extension and label only. The get gives every field.

List Hunt GroupsGET /v1/hunt-groups

Get a Hunt GroupGET /v1/hunt-groups/{id}