This document is for an older version of Kazoo (version 4.3) that is no longer supported. You should upgrade and read the current documentation.

Ring Group

About Ring Group

Ring group callflow element allows calling multiple endpoints with given strategy and timeout.

Schema

Validator for the Ring Group callflow element

KeyDescriptionTypeDefaultRequiredSupport Level
endpoints.[].delayHow long to delay ringing the endpoint, in secondsinteger()0false
endpoints.[].endpoint_typeThe type (device, user, etc) of endpoint`string(‘device''user''group’)`
endpoints.[].idThe ID of the endpointstring(1..128)true
endpoints.[].timeoutHow long to ring the endpoint, in secondsinteger()20false
endpoints.[].weightWeight of endpoint, different usage in various strategiesinteger()false
endpointsEndpoint IDs (devices, users, etc) included in the ring grouparray(object())true
fail_on_single_rejectIf any leg rejects the call, cancel all other legsboolean()false
ignore_forwardIf true, will ignore SIP redirect requests for call-forwarded devicesboolean()truefalse
repeatsHow many times to retry the ring groupinteger()1false
ringbackRingback to usestring()false
ringtones.externalRing tone for calls from external sourcesstring()false
ringtones.internalRing tone for calls from external sourcesstring()false
ringtonesobject()false
skip_moduleWhen set to true this callflow action is skipped, advancing to the wildcard branch (if any)boolean()false
strategyHow to ring the members of the group`string(‘simultaneous''single''weighted_random’)`simultaneous
timeoutHow long to ring the ring group before continuing, in secondsinteger()20false

Strategy

There are three strategies that can be chosen:

  • single - ring one endpoint after another
  • simultaneous - ring all endpoints at the same time (default)
  • weighted_random - randomize the list of endpoints, then use single strategy

Endpoints

Endpoints can be:

  • device - a single device will be added to the ring group
  • user - all devices of the user will be added to the ring group
  • group - all devices of a group will be added to the ring group

Once all the endpoints have been resolved, the strategy will be applied to the resulting list of devices and the ring group will be executed.

On this page