Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ring Groups

Manage your ring groups.

List ring groups.

get

Retrieve a collection of ring groups.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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
countinteger · int64Optional

Total number of resource.

Example: 100
get/ring_groups
GET /api/ring_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "extension_number": "101",
      "ring_time": 20,
      "ring_strategy": "RING_SIMULTANEOUSLY",
      "skip_busy_member": true,
      "enable_paid": true,
      "enable_prid": true,
      "enable_night_mode": false,
      "extension_number_as_to_header": false,
      "no_answer_forward_rule": {
        "action": "HANGUP"
      },
      "night_mode_forward_rule": {
        "action": "HANGUP"
      },
      "enable_audio_recording": false
    }
  ]
}

Create a ring group

post

Add a new ring group.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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: false
enable_pridbooleanOptional

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

Default: false
enable_night_modebooleanOptional

Whether to enable night mode.

Default: false
extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false
enable_audio_recordingbooleanOptional

Whether to enable audio recording.

Default: false
Responses
200

Created ring group

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
post/ring_groups
POST /api/ring_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "name": "example",
  "extension_number": "101",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "enable_paid": true,
  "enable_prid": true,
  "enable_night_mode": true,
  "extension_number_as_to_header": false,
  "no_answer_forward_rule": {
    "action": "HANGUP"
  },
  "night_mode_forward_rule": {
    "action": "HANGUP"
  },
  "outbound_caller_ids": [
    {
      "provider_id": "xxxxxx",
      "caller_id": "1000",
      "description": "example",
      "display_name": "1000"
    }
  ],
  "enable_audio_recording": false
}
{
  "id": "xxxxxxxx"
}

Retrieve a ring group

get

Retrieve ring group by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
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: false
enable_pridbooleanOptional

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

Default: false
enable_night_modebooleanOptional

Whether to enable night mode.

Default: false
extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false
enable_audio_recordingbooleanOptional

Whether to enable audio recording.

Default: false
get/ring_groups/{id}
GET /api/ring_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "name": "example",
  "extension_number": "101",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "enable_paid": true,
  "enable_prid": true,
  "enable_night_mode": true,
  "extension_number_as_to_header": false,
  "no_answer_forward_rule": {
    "action": "HANGUP"
  },
  "night_mode_forward_rule": {
    "action": "HANGUP"
  },
  "outbound_caller_ids": [
    {
      "provider_id": "xxxxxx",
      "provider_name": "some trunk",
      "provider_brand": "Generic",
      "provider_did_numbers": "1000-2000",
      "caller_id": "1000",
      "description": "example",
      "display_name": "1000"
    }
  ],
  "enable_audio_recording": false
}

Update a ring group

post

Update a ring group

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: 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: false
enable_pridbooleanOptional

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

Default: false
enable_night_modebooleanOptional

Whether to enable night mode.

Default: false
extension_number_as_to_headerbooleanOptional

Whether to user extension number as invite To header.

Default: false
enable_audio_recordingbooleanOptional

Whether to enable audio recording.

Default: false
Responses
200

OK

No content
post/ring_groups/{id}
POST /api/ring_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 432

{
  "name": "example",
  "ring_time": 20,
  "ring_strategy": "RING_SIMULTANEOUSLY",
  "skip_busy_member": true,
  "enable_paid": true,
  "enable_prid": true,
  "enable_night_mode": true,
  "extension_number_as_to_header": false,
  "no_answer_forward_rule": {
    "action": "HANGUP"
  },
  "night_mode_forward_rule": {
    "action": "HANGUP"
  },
  "outbound_caller_ids": [
    {
      "provider_id": "xxxxxx",
      "caller_id": "1000",
      "description": "example",
      "display_name": "1000"
    }
  ],
  "enable_audio_recording": false
}
No content

List ring group agents

get

Retrieve a collection of ring group agents.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
get/ring_groups/{id}/agents
GET /api/ring_groups/{id}/agents HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "extension_number": "101",
      "display_name": "example",
      "skill_level": 1
    }
  ]
}

Update ring group member list

post

Update ring group member list.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Body
Responses
200

OK

No content
post/ring_groups/{id}/agents
POST /api/ring_groups/{id}/agents HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "items": [
    {
      "extension_number": "101",
      "skill_level": 1
    }
  ]
}
No content

Retrieve ring group agent details.

get

Retrieve information of ring group agent.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
agent_numberstring · min: 3 · max: 64Required

The extension number.

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

OK

application/json
extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}
display_namestring · min: 1 · max: 128Optional

The display name of user.

skill_levelinteger · int32 · min: 1 · max: 100Optional

The skill level of agent in ring group.
Only valid when ring_strategy is skill based.

Default: 1
get/ring_groups/{id}/agents/{agent_number}
GET /api/ring_groups/{id}/agents/{agent_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "extension_number": "101",
  "display_name": "example",
  "skill_level": 1
}

Destroy a ring group

post

Destroy a ring group

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post/ring_groups/{id}/destroy
POST /api/ring_groups/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousPush Notification
NextShared Voicemails

Last updated

Was this helpful?