Group

About Group

Creates a group of endpoints to be rung when a call comes in.

Schema

Validator for the group callflow data object

KeyDescriptionTypeDefaultRequiredSupport Level
endpoints.[]string()false
endpointsList of endpoint (device/user/group) IDsarray(string())[]false
fail_on_single_rejectIf any leg rejects the call, cancel all other legsboolean()false
group_idID of the groupstring()false
group_namegroup namestring()false
hard_stop_after_successful_groupshould hard stop on successful bridgeboolean()false
idGroup IDstring()false
ignore_early_mediaignore early mediaboolean()false
ignore_forwardWhether to ignore forwarded phonesboolean()truefalse
repeatsHow many times to repeat dialing the 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
sca.enabledis sca enabledboolean()false
scaobject()false
skip_moduleWhen set to true this callflow action is skipped, advancing to the wildcard branch (if any)boolean()false
strategyHow to ring the endpoints`string(‘single''simultaneous’)`simultaneousfalse
timeoutHow long to attempt the groupinteger()20false

On this page