Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ring_group.md #6744

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update ring_group.md #6744

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d84850
Update ring_group.md
dschreiber Dec 2, 2021
7476a83
Update ring_group.md
dschreiber Dec 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions applications/callflow/doc/ring_group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' )` | `simultaneous` | `false` | supported
`timeout` | How long to ring the ring group before continuing, in seconds | `integer()` | `20` | `false` | supported



Expand All @@ -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

Expand Down