Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit f555360

Browse files
committed
Updated the README file
1 parent 2d315f0 commit f555360

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/Telephony/Readme.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,19 +120,22 @@ The Stop Recording action stops recording of the conversation. Note that it is n
120120
## **Aggregate DTMF Input (n)**
121121
Prompts the user for multiple inputs that are aggregated until a specified character length is met or exceeded.
122122
Speech, DTMF inputs, and chat provided characters can all be used to provide input, but any inputs that aren't the characters 1,2,3,4,5,6,7,8,9,0,#,*, or some combination of said characters are dropped.
123+
In case the timeout in milliseconds is reached, the dialog will end and show the Default Value property to the user.
123124

124125
#### Parameters
125126
* Batch Length
126127
* Property
127128
* Prompt
128129
* AllowInterruptions
129130
* AlwaysPrompt
131+
* Timeout
132+
* Default Value
130133

131134
#### Usage
132135
* After started, each input the user sends will be appended to the last message until the user provides a number of characters equal to or greater than the batch length.
133136

134137
#### Dialog Flow
135-
* The dialog will only end and continue to the next dialog when the batch length is reached.
138+
* The dialog will only end and continue to the next dialog when the batch length is reached or the timeout is reached.
136139
* If AllowInterruptions is true, the parent dialog will receive non-digit input and can handle it as an intent.
137140
* After the interruption is handled, control flow will resume with this dialog. If AlwaysPrompt is set to true, the dialog will attempt to start over, otherwise it will end this dialog without setting the output property.
138141
* Best practice recommendation when using interruptions is to validate that the output property has been set and handle the case in which it is and isn't set.'
@@ -145,19 +148,22 @@ Speech, DTMF inputs, and chat provided characters can all be used to provide inp
145148
## **Aggregate DTMF Input (#)**
146149
Prompts the user for multiple inputs that are aggregated until the termination string is received.
147150
Speech, DTMF inputs, and chat provided characters can all be used to provide input, but any inputs that aren't the characters 1,2,3,4,5,6,7,8,9,0,#,*, or some combination of said characters are dropped.
151+
In case the timeout in milliseconds is reached, the dialog will end and show the Default Value property to the user.
148152

149153
#### Parameters
150154
* Termination Character
151155
* Property
152156
* Prompt
153157
* AllowInterruptions
154158
* AlwaysPrompt
159+
* Timeout
160+
* Default Value
155161

156162
#### Usage
157163
* After started, each input the user sends will be appended to the last message until the user sends the provided termination character
158164

159165
#### Dialog Flow
160-
* The dialog will only end and continue to the next dialog when the termination character is sent.
166+
* The dialog will only end and continue to the next dialog when the termination character is sent or the timeout is reached.
161167
* If AllowInterruptions is true, the parent dialog will receive non-digit input and can handle it as an intent.
162168
* After the interruption is handled, control flow will resume with this dialog. If AlwaysPrompt is set to true, the dialog will attempt to start over, otherwise it will end this dialog without setting the output property.
163169
* Best practice recommendation when using interruptions is to validate that the output property has been set and handle the case in which it is and isn't set.'

0 commit comments

Comments
 (0)