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

Jump to bottom

Update accounts.md #6735

Open
wants to merge 1 commit into
base: 4.2
Choose a base branch
from
Open

Update accounts.md #6735

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions applications/crossbar/doc/ref/accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Key | Description | Type | Default | Required | Support Level
`call_restriction` | Account level call restrictions for each available number classification | `object()` | `{}` | `false` |
`call_waiting` | | [#/definitions/call_waiting](#call_waiting) | | `false` |
`caller_id` | The account default caller ID parameters | [#/definitions/caller_id](#caller_id) | | `false` |
`caller_id_options.outbound_privacy` | Determines what appears as caller id for offnet outbound calls. Values: full - hides name and number; name - hides only name; number - hides only number; none - hides nothing | `string('full' | 'name' | 'number' | 'none')` | | `false` |
`caller_id_options.outbound_privacy` | Determines what appears as caller id for offnet outbound calls. Values: full - hides name and number; name - hides only name; number - hides only number; none - hides nothing | `string('full' \| 'name' \| 'number' \| 'none')` | | `false` |
`caller_id_options` | custom properties for configuring caller_id | `object()` | | `false` |
`dial_plan` | A list of default rules used to modify dialed numbers | [#/definitions/dialplans](#dialplans) | | `false` |
`do_not_disturb.enabled` | The default value for do-not-disturb | `boolean()` | | `false` |
Expand Down Expand Up @@ -70,7 +70,7 @@ Key | Description | Type | Default | Required | Support Level
Key | Description | Type | Default | Required | Support Level
--- | ----------- | ---- | ------- | -------- | -------------
`enabled` | is recording enabled | `boolean()` | | `false` |
`format` | What format to store the recording on disk | `string('mp3' | 'wav')` | | `false` |
`format` | What format to store the recording on disk | `string('mp3' \| 'wav')` | | `false` |
`record_min_sec` | The minimum length, in seconds, the recording must be to be considered successful. Otherwise it is deleted | `integer()` | | `false` |
`record_on_answer` | Recording should start on answer | `boolean()` | | `false` |
`record_on_bridge` | Recording should start on bridge | `boolean()` | | `false` |
Expand Down Expand Up @@ -139,7 +139,7 @@ Schema for formatter options

Key | Description | Type | Default | Required | Support Level
--- | ----------- | ---- | ------- | -------- | -------------
`direction` | Only apply the formatter on the relevant request direction | `string('inbound' | 'outbound' | 'both')` | | `false` |
`direction` | Only apply the formatter on the relevant request direction | `string('inbound' \| 'outbound' \| 'both')` | | `false` |
`match_invite_format` | Applicable on fields with SIP URIs. Will format the username portion to match the invite format of the outbound request. | `boolean()` | | `false` |
`prefix` | Prepends value against the result of a successful regex match | `string()` | | `false` |
`regex` | Matches against the value, with optional capture group | `string()` | | `false` |
Expand All @@ -166,9 +166,9 @@ Actions applied to a call outside of the normal callflow, initiated by the calle

Key | Description | Type | Default | Required | Support Level
--- | ----------- | ---- | ------- | -------- | -------------
`binding_digit` | What DTMF will trigger the collection and analysis of the subsequent DTMF sequence | `string('1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '0' | '*' | '#')` | `*` | `false` |
`binding_digit` | What DTMF will trigger the collection and analysis of the subsequent DTMF sequence | `string('1' \| '2' \| '3' \| '4' \| '5' \| '6' \| '7' \| '8' \| '9' \| '0' \| '*' \| '#')` | `*` | `false` |
`digit_timeout` | How long to wait between DTMF presses before processing the collected sequence (milliseconds) | `integer()` | | `false` |
`listen_on` | Which leg(s) of the call to listen for DTMF | `string('both' | 'self' | 'peer')` | | `false` |
`listen_on` | Which leg(s) of the call to listen for DTMF | `string('both' \| 'self' \| 'peer')` | | `false` |
`numbers./^[0-9]+$/` | | [#/definitions/metaflow](#metaflow) | | `false` |
`numbers` | A list of static numbers with their flows | `object()` | | `false` |
`patterns./.+/` | | [#/definitions/metaflow](#metaflow) | | `false` |
Expand Down