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

change IVR to ivr when used as a key, for snake_case consistency #67

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

change IVR to ivr when used as a key, for snake_case consistency #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f963b81
change IVR to ivr when used as a key, for snake_case consistency
seifertk Jul 27, 2022
b1ecf44
switch IVR to ivr in block config descriptions
seifertk Jul 27, 2022
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
18 changes: 9 additions & 9 deletions layers/2-mobile-primitives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ These tests apply to non-IVR flows. There may be multiple tests per choice: any

| Key | Description |
| :--- | :--- |
| `IVR`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. |
| `IVR`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. |
| `ivr`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. |
| `ivr`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. |

### Detailed behaviour by mode

Expand Down Expand Up @@ -374,8 +374,8 @@ These tests apply to non-IVR flows. There may be multiple tests per choice: any

| Key | Description |
| :--- | :--- |
| `IVR`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. |
| `IVR`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. |
| `ivr`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. |
| `ivr`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. |

### Detailed behaviour by mode

Expand Down Expand Up @@ -515,7 +515,7 @@ This block obtains a numeric response from the contact.

| Key | Description |
| :--- | :--- |
| `IVR`: `max_digits` \(number\) | After receiving this many digits, do not wait for any more; accept the digits entered so far as the complete response. |
| `ivr`: `max_digits` \(number\) | After receiving this many digits, do not wait for any more; accept the digits entered so far as the complete response. |

This block can be configured to have a single exit, or a number of exits with possibilities based on the range of the numeric response given. The exit specification is as described in [Block `exits`](../flows.md#blocks).

Expand Down Expand Up @@ -544,7 +544,7 @@ This block writes the numeric value received to the output variable correspondin
"prompt": "986a0f39-bfdf-4aa0-9fe2-28c90f422e1f",
"validation_minimum": 0,
"validation_maximum": 120,
"IVR": {
"ivr": {
"max_digits": 3
}
}
Expand All @@ -571,8 +571,8 @@ This block can be configured to have a single exit, or a number of exits with po

| Key | Description |
| :--- | :--- |
| `IVR`: `max_duration_seconds` \(number\) | The maximum duration to record for, before proceeding to the next block. |
| `IVR`: `end_recording_digits` \(string, optional\) | A set of key-press digits that terminate an open-ended recording, e.g.: "1789#" |
| `ivr`: `max_duration_seconds` \(number\) | The maximum duration to record for, before proceeding to the next block. |
| `ivr`: `end_recording_digits` \(string, optional\) | A set of key-press digits that terminate an open-ended recording, e.g.: "1789#" |

### Detailed behaviour by mode

Expand All @@ -598,7 +598,7 @@ For `TEXT`, `OFFLINE`, and `RICH_MESSAGING` modes that capture a text response,
"exits": [...],
"config": {
"prompt": "b969cd54-c894-4f5a-891e-f1b24e32982b",
"IVR": {
"ivr": {
"max_duration_seconds": 120,
"end_recording_digits": "1234567890#*"
}
Expand Down