From 0d848500f0fd015f6d4cd172a526656913ebfdc4 Mon Sep 17 00:00:00 2001 From: Darren Schreiber Date: Thu, 2 Dec 2021 13:44:37 -0800 Subject: [PATCH 1/2] Update ring_group.md --- applications/callflow/doc/ring_group.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/applications/callflow/doc/ring_group.md b/applications/callflow/doc/ring_group.md index fa947ca4778..032abd2ca4c 100644 --- a/applications/callflow/doc/ring_group.md +++ b/applications/callflow/doc/ring_group.md @@ -12,22 +12,22 @@ Validator for the Ring Group callflow element Key | Description | Type | Default | Required | Support Level --- | ----------- | ---- | ------- | -------- | ------------- -`endpoints.[].delay` | How long to delay ringing the endpoint, in seconds | `integer()` | `0` | `false` | -`endpoints.[].endpoint_type` | The type (device, user, etc) of endpoint | `string('device' | 'user' | 'group')` | | `true` | -`endpoints.[].id` | The ID of the endpoint | `string(1..128)` | | `true` | -`endpoints.[].timeout` | How long to ring the endpoint, in seconds | `integer()` | `20` | `false` | +`endpoints.[].delay` | How long to delay ringing the endpoint, in seconds | `integer()` | `0` | `false` | supported +`endpoints.[].endpoint_type` | The type (device, user, etc) of endpoint | `string('device' | 'user' | 'group')` | | `true` | supported +`endpoints.[].id` | The ID of the endpoint | `string(1..128)` | | `true` | supported +`endpoints.[].timeout` | How long to ring the endpoint, in seconds | `integer()` | `20` | `false` | supported `endpoints.[].weight` | Weight of endpoint, different usage in various strategies | `integer()` | | `false` | `endpoints` | Endpoint IDs (devices, users, etc) included in the ring group | `array(object())` | | `true` | `fail_on_single_reject` | If any leg rejects the call, cancel all other legs | `boolean()` | | `false` | `ignore_forward` | If true, will ignore SIP redirect requests for call-forwarded devices | `boolean()` | `true` | `false` | -`repeats` | How many times to retry the ring group | `integer()` | `1` | `false` | +`repeats` | How many times to retry the ring group | `integer()` | `1` | `false` | supported `ringback` | Ringback to use | `string()` | | `false` | `ringtones.external` | Ring tone for calls from external sources | `string()` | | `false` | `ringtones.internal` | Ring tone for calls from external sources | `string()` | | `false` | `ringtones` | | `object()` | | `false` | `skip_module` | When set to true this callflow action is skipped, advancing to the wildcard branch (if any) | `boolean()` | | `false` | -`strategy` | How to ring the members of the group | `string('simultaneous' | 'single' | 'weighted_random')` | `simultaneous` | `false` | -`timeout` | How long to ring the ring group before continuing, in seconds | `integer()` | `20` | `false` | +`strategy` | How to ring the members of the group | `string('simultaneous' | 'single' | 'weighted_random')` | `simultaneous` | `false` | supported +`timeout` | How long to ring the ring group before continuing, in seconds | `integer()` | `20` | `false` | supported @@ -40,7 +40,6 @@ 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 From 7476a83ab531f1df6ebbb563ab18dc6997265551 Mon Sep 17 00:00:00 2001 From: Darren Schreiber Date: Thu, 2 Dec 2021 13:48:38 -0800 Subject: [PATCH 2/2] Update ring_group.md Missed a spot for weighted ring gruop --- applications/callflow/doc/ring_group.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/applications/callflow/doc/ring_group.md b/applications/callflow/doc/ring_group.md index 032abd2ca4c..aa7a366ae62 100644 --- a/applications/callflow/doc/ring_group.md +++ b/applications/callflow/doc/ring_group.md @@ -26,7 +26,7 @@ Key | Description | Type | Default | Required | Support Level `ringtones.internal` | Ring tone for calls from external sources | `string()` | | `false` | `ringtones` | | `object()` | | `false` | `skip_module` | When set to true this callflow action is skipped, advancing to the wildcard branch (if any) | `boolean()` | | `false` | -`strategy` | How to ring the members of the group | `string('simultaneous' | 'single' | 'weighted_random')` | `simultaneous` | `false` | supported +`strategy` | How to ring the members of the group | `string('simultaneous' | 'single' )` | `simultaneous` | `false` | supported `timeout` | How long to ring the ring group before continuing, in seconds | `integer()` | `20` | `false` | supported